Javadoc

Author: garydgregory

src/main/java/org/apache/commons/io/build/AbstractOrigin.java

@@ -422,6 +422,13 @@ public ByteArrayOrigin(final byte[] origin) {
             super(origin);
         }
 
+        /**
+         * {@inheritDoc}
+         *
+         * <p>
+         * No conversion should occur when calling this method.
+         * </p>
+         */
         @Override
         public byte[] getByteArray() {
             // No conversion
@@ -483,6 +490,13 @@ public byte[] getByteArray() throws IOException {
             return IOUtils.toByteArray(getInputStream());
         }
 
+        /**
+         * {@inheritDoc}
+         *
+         * <p>
+         * No conversion should occur when calling this method.
+         * </p>
+         */
         @Override
         protected Channel getChannel(final OpenOption... options) throws IOException {
             // No conversion
@@ -560,6 +574,9 @@ protected Channel getChannel(final OpenOption... options) throws IOException {
          * <p>
          * The {@code charset} parameter is ignored since a {@link CharSequence} does not need a {@link Charset} to be read.
          * </p>
+         * <p>
+         * No conversion should occur when calling this method.
+         * </p>
          */
         @Override
         public CharSequence getCharSequence(final Charset charset) {
@@ -626,6 +643,13 @@ protected Channel getChannel(final OpenOption... options) throws IOException {
             return Files.newByteChannel(getPath(), options);
         }
 
+        /**
+         * {@inheritDoc}
+         *
+         * <p>
+         * No conversion should occur when calling this method.
+         * </p>
+         */
         @Override
         public File getFile() {
             // No conversion
@@ -670,6 +694,9 @@ protected Channel getChannel(final OpenOption... options) throws IOException {
          * <p>
          * The {@code options} parameter is ignored since a {@link InputStream} does not need an {@link OpenOption} to be read.
          * </p>
+         * <p>
+         * No conversion should occur when calling this method.
+         * </p>
          */
         @Override
         public InputStream getInputStream(final OpenOption... options) {
@@ -748,6 +775,9 @@ protected Channel getChannel(final OpenOption... options) throws IOException {
          * <p>
          * The {@code options} parameter is ignored since a {@link OutputStream} does not need an {@link OpenOption} to be written.
          * </p>
+         * <p>
+         * No conversion should occur when calling this method.
+         * </p>
          */
         @Override
         public OutputStream getOutputStream(final OpenOption... options) {
@@ -799,6 +829,13 @@ public File getFile() {
             return get().toFile();
         }
 
+        /**
+         * {@inheritDoc}
+         *
+         * <p>
+         * No conversion should occur when calling this method.
+         * </p>
+         */
         @Override
         public Path getPath() {
             // No conversion
@@ -885,6 +922,9 @@ public InputStream getInputStream(final OpenOption... options) throws IOExceptio
          * <p>
          * The {@code charset} parameter is ignored since a {@link Reader} does not need a {@link Charset} to be read.
          * </p>
+         * <p>
+         * No conversion should occur when calling this method.
+         * </p>
          */
         @Override
         public Reader getReader(final Charset charset) throws IOException {
@@ -983,6 +1023,9 @@ public OutputStream getOutputStream(final OpenOption... options) throws IOExcept
          * <p>
          * The {@code options} parameter is ignored since a {@link Writer} does not need an {@link OpenOption} to be written.
          * </p>
+         * <p>
+         * No conversion should occur when calling this method.
+         * </p>
          */
         @Override
         public Writer getWriter(final Charset charset, final OpenOption... options) throws IOException {