Polish Javadoc

This commit is contained in:
Phillip Webb
2015-09-06 00:28:00 -07:00
parent e07df7e4c6
commit e674d751de
252 changed files with 680 additions and 348 deletions

View File

@@ -34,6 +34,9 @@ import org.json.JSONException;
*/
public final class ConfigurationMetadataRepositoryJsonBuilder {
/**
* UTF-8 Charset.
*/
public static final Charset UTF_8 = Charset.forName("UTF-8");
private Charset defaultCharset = UTF_8;
@@ -54,7 +57,7 @@ public final class ConfigurationMetadataRepositoryJsonBuilder {
* Leaves the stream open when done.
* @param inputStream the source input stream
* @return this builder
* @throws IOException
* @throws IOException in case of I/O errors
*/
public ConfigurationMetadataRepositoryJsonBuilder withJsonResource(
InputStream inputStream) throws IOException {
@@ -71,7 +74,7 @@ public final class ConfigurationMetadataRepositoryJsonBuilder {
* @param inputstream the source input stream
* @param charset the charset of the input
* @return this builder
* @throws IOException
* @throws IOException in case of I/O errors
*/
public ConfigurationMetadataRepositoryJsonBuilder withJsonResource(
InputStream inputstream, Charset charset) throws IOException {

View File

@@ -45,7 +45,7 @@ public class ConfigurationMetadataSource implements Serializable {
private final Map<String, ConfigurationMetadataProperty> properties = new HashMap<String, ConfigurationMetadataProperty>();
/**
* The identifier of the group to which this source is associated
* The identifier of the group to which this source is associated.
* @return the group id
*/
public String getGroupId() {

View File

@@ -28,7 +28,7 @@ import org.json.JSONArray;
import org.json.JSONObject;
/**
* Read standard json metadata format as {@link ConfigurationMetadataRepository}
* Read standard json metadata format as {@link ConfigurationMetadataRepository}.
*
* @author Stephane Nicoll
* @since 1.3.0

View File

@@ -66,6 +66,7 @@ class RawConfigurationMetadata {
/**
* Resolve the name of an item against this instance.
* @param item the item to resolve
* @see ConfigurationMetadataProperty#setName(String)
*/
private void resolveName(ConfigurationMetadataItem item) {