o Clarified API

git-svn-id: https://svn.apache.org/repos/asf/maven/components/branches/MNG-2766@778489 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Benjamin Bentmann 2009-05-25 20:05:02 +00:00
parent 420d44adf6
commit f82b30a6a1
2 changed files with 8 additions and 4 deletions

View File

@ -53,7 +53,8 @@ public interface ModelReader
throws IOException;
/**
* Reads the model from the specified character reader.
* Reads the model from the specified character reader. The reader will be automatically closed before the method
* returns.
*
* @param input The reader to deserialize the model from, must not be {@code null}.
* @param options The options to use for deserialization, may be {@code null} to use the default values.
@ -64,7 +65,8 @@ public interface ModelReader
throws IOException;
/**
* Reads the model from the specified byte stream.
* Reads the model from the specified byte stream. The stream will be automatically closed before the method
* returns.
*
* @param input The stream to deserialize the model from, must not be {@code null}.
* @param options The options to use for deserialization, may be {@code null} to use the default values.

View File

@ -48,7 +48,8 @@ public interface ModelWriter
throws IOException;
/**
* Writes the supplied model to the specified character writer.
* Writes the supplied model to the specified character writer. The writer will be automatically closed before the
* method returns.
*
* @param output The writer to serialize the model to, must not be {@code null}.
* @param options The options to use for serialization, may be {@code null} to use the default values.
@ -59,7 +60,8 @@ public interface ModelWriter
throws IOException;
/**
* Writes the supplied model to the specified byte stream.
* Writes the supplied model to the specified byte stream. The stream will be automatically closed before the method
* returns.
*
* @param output The stream to serialize the model to, must not be {@code null}.
* @param options The options to use for serialization, may be {@code null} to use the default values.