http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java index 638ae24..81f58e7 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/Schema.java @@ -24,7 +24,7 @@ import org.apache.juneau.transform.*; /** * Represents a top-level schema object bean in the JSON-Schema core specification. * <p> - * Refer to <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> for usage information. + * Refer to <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> for usage information. */ @SuppressWarnings("hiding") @Bean(typeName="schema", @@ -131,7 +131,7 @@ public class Schema { * Bean property setter: <property>id</property>. * * @param id The new value for the <property>id</property> property on this bean. - * The parameter must be a valid URI. It can be <jk>null</jk>. + * The parameter must be a valid URI. It can be <jk>null</jk>. * @return This object (for method chaining). */ public Schema setId(String id) { @@ -164,7 +164,7 @@ public class Schema { * Bean property setter: <property>schemaVersion</property>. * * @param schemaVersion The new value for the <property>schemaVersion</property> property on this bean. - * The parameter must be a valid URI. It can be <jk>null</jk>. + * The parameter must be a valid URI. It can be <jk>null</jk>. * @return This object (for method chaining). */ public Schema setSchemaVersionUri(String schemaVersion) { @@ -215,7 +215,7 @@ public class Schema { * Bean property getter: <property>type</property>. * * @return The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set. - * Can be either a {@link JsonType} or {@link JsonTypeArray} depending on what value was used to set it. + * Can be either a {@link JsonType} or {@link JsonTypeArray} depending on what value was used to set it. */ @BeanProperty(swap=JsonTypeOrJsonTypeArraySwap.class) public Object getType() { @@ -252,7 +252,7 @@ public class Schema { * Bean property setter: <property>type</property>. * * @param type The new value for the <property>type</property> property on this bean. - * This object must be of type {@link JsonType} or {@link JsonTypeArray}. + * This object must be of type {@link JsonType} or {@link JsonTypeArray}. * @return This object (for method chaining). * @throws BeanRuntimeException If invalid object type passed in. */ @@ -510,7 +510,7 @@ public class Schema { * Bean property getter: <property>items</property>. * * @return The value of the <property>items</property> property on this bean, or <jk>null</jk> if it is not set. - * Can be either a {@link Schema} or {@link SchemaArray} depending on what value was used to set it. + * Can be either a {@link Schema} or {@link SchemaArray} depending on what value was used to set it. */ @BeanProperty(swap=SchemaOrSchemaArraySwap.class) public Object getItems() { @@ -569,7 +569,7 @@ public class Schema { * Bean property setter: <property>items</property>. * * @param items The new value for the <property>items</property> property on this bean. - * This object must be of type {@link Schema} or {@link SchemaArray}. + * This object must be of type {@link Schema} or {@link SchemaArray}. * @return This object (for method chaining). * @throws BeanRuntimeException If invalid object type passed in. */ @@ -767,7 +767,7 @@ public class Schema { * Bean property getter: <property>additionalItems</property>. * * @return The value of the <property>additionalItems</property> property on this bean, or <jk>null</jk> if it is not set. - * Can be either a {@link Boolean} or {@link SchemaArray} depending on what value was used to set it. + * Can be either a {@link Boolean} or {@link SchemaArray} depending on what value was used to set it. */ @BeanProperty(swap=BooleanOrSchemaArraySwap.class) public Object getAdditionalItems() { @@ -804,7 +804,7 @@ public class Schema { * Bean property setter: <property>additionalItems</property>. * * @param additionalItems The new value for the <property>additionalItems</property> property on this bean. - * This object must be of type {@link Boolean} or {@link SchemaArray}. + * This object must be of type {@link Boolean} or {@link SchemaArray}. * @return This object (for method chaining). * @throws BeanRuntimeException If invalid object type passed in. */ @@ -1025,7 +1025,7 @@ public class Schema { * Bean property getter: <property>additionalProperties</property>. * * @return The value of the <property>additionalProperties</property> property on this bean, or <jk>null</jk> if it is not set. - * Can be either a {@link Boolean} or {@link SchemaArray} depending on what value was used to set it. + * Can be either a {@link Boolean} or {@link SchemaArray} depending on what value was used to set it. */ @BeanProperty(swap=BooleanOrSchemaSwap.class) public Object getAdditionalProperties() { @@ -1062,7 +1062,7 @@ public class Schema { * Bean property setter: <property>additionalProperties</property>. * * @param additionalProperties The new value for the <property>additionalProperties</property> property on this bean. - * This object must be of type {@link Boolean} or {@link Schema}. + * This object must be of type {@link Boolean} or {@link Schema}. * @return This object (for method chaining). * @throws BeanRuntimeException If invalid object type passed in. */ @@ -1362,7 +1362,7 @@ public class Schema { * Bean property setter: <property>$ref</property>. * * @param ref The new value for the <property>$ref</property> property on this bean. - * The parameter must be a valid URI. It can be <jk>null</jk>. + * The parameter must be a valid URI. It can be <jk>null</jk>. * @return This object (for method chaining). */ public Schema setRef(String ref) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java index 2a06e10..caa81b3 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaArray.java @@ -17,7 +17,7 @@ import java.util.*; /** * Represents a list of {@link Schema} objects. * <p> - * Refer to <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> for usage information. + * Refer to <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> for usage information. */ public class SchemaArray extends LinkedList<Schema> { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java index cdccebe..85998f3 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaMap.java @@ -21,7 +21,7 @@ import org.apache.juneau.json.*; /** * A container for retrieving JSON {@link Schema} objects by URI. * <p> - * Subclasses must implement one of the following methods to load schemas from external sources: + * Subclasses must implement one of the following methods to load schemas from external sources: * <ul class='spaced-list'> * <li>{@link #getReader(URI)} - If schemas should be loaded from readers and automatically parsed. * <li>{@link #load(URI)} - If you want control over construction of {@link Schema} objects. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java index 365d09f..124022b 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaProperty.java @@ -15,7 +15,7 @@ package org.apache.juneau.dto.jsonschema; /** * Represents a JSON property in the JSON-Schema core specification. * <p> - * Refer to <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> for usage information. + * Refer to <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> for usage information. */ public class SchemaProperty extends Schema { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java index 42e1af5..d869a3c 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.java @@ -15,7 +15,7 @@ package org.apache.juneau.dto.jsonschema; /** * Convenience class for representing a property that's an array of simple types. * <p> - * An instance of this object is equivalent to calling... + * An instance of this object is equivalent to calling... * * <p class='bcode'> * SchemaProperty p = <jk>new</jk> SchemaProperty(name) http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java index 0daaa59..3f91548 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/SchemaRef.java @@ -17,7 +17,7 @@ import java.net.*; /** * Convenience class for representing a schema reference such as <js>"{'$ref':'/url/to/ref'}"</js>. * <p> - * An instance of this object is equivalent to calling... + * An instance of this object is equivalent to calling... * * <p class='bcode'> * Schema s = <jk>new</jk> Schema().setRef(uri); http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java index 8b36f83..7f1456f 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java @@ -670,7 +670,7 @@ public class HeaderInfo extends SwaggerElement { * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76";>http://json-schema.org/latest/json-schema-validation.html#anchor76</a>. * * @param _enum The new values to add to the <property>enum</property> property on this bean. - * These can either be individual objects or {@link Collection Collections} of objects. + * These can either be individual objects or {@link Collection Collections} of objects. * @return This object (for method chaining). */ public HeaderInfo addEnum(Object..._enum) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java index a3d9633..82283fc 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java @@ -636,7 +636,7 @@ public class Items extends SwaggerElement { * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76";>http://json-schema.org/latest/json-schema-validation.html#anchor76</a>. * * @param _enum The new values to add to the <property>enum</property> property on this bean. - * These can either be individual objects or {@link Collection Collections} of objects. + * These can either be individual objects or {@link Collection Collections} of objects. * @return This object (for method chaining). */ public Items addEnum(Object..._enum) { @@ -658,7 +658,7 @@ public class Items extends SwaggerElement { * Synonym for {@link #addEnum(Object...)}. * * @param _enum The new values to add to the <property>enum</property> property on this bean. - * These can either be individual objects or {@link Collection Collections} of objects. + * These can either be individual objects or {@link Collection Collections} of objects. * @return This object (for method chaining). */ public Items _enum(Object..._enum) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java index 0c1472e..8dc3e50 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java @@ -143,7 +143,7 @@ public class Operation extends SwaggerElement { * Tags can be used for logical grouping of operations by resources or any other qualifier. * * @param tags The values to add for the <property>tags</property> property on this bean. - * Ignored if <jk>null</jk>. + * Ignored if <jk>null</jk>. * @return This object (for method chaining). */ public Operation addTags(Collection<String> tags) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java index 5b90235..98674b2 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java @@ -905,7 +905,7 @@ public class ParameterInfo extends SwaggerElement { * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76";>http://json-schema.org/latest/json-schema-validation.html#anchor76</a>. * * @param _enum The new values to add to the <property>enum</property> property on this bean. - * These can either be individual objects or {@link Collection Collections} of objects. + * These can either be individual objects or {@link Collection Collections} of objects. * @return This object (for method chaining). */ @SuppressWarnings("unchecked") @@ -928,7 +928,7 @@ public class ParameterInfo extends SwaggerElement { * Synonym for {@link #addEnum(Object...)}. * * @param _enum The new values to add to the <property>enum</property> property on this bean. - * These can either be individual objects or {@link Collection Collections} of objects. + * These can either be individual objects or {@link Collection Collections} of objects. * @return This object (for method chaining). */ public ParameterInfo _enum(Object..._enum) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java index 0aec92f..8d84b30 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java @@ -637,7 +637,7 @@ public class SchemaInfo extends SwaggerElement { * Bean property adder: <property>enum</property>. * * @param _enum The new values to add to the <property>enum</property> property on this bean. - * These can either be individual objects or {@link Collection Collections} of objects. + * These can either be individual objects or {@link Collection Collections} of objects. * @return This object (for method chaining). */ public SchemaInfo addEnum(Object..._enum) { @@ -659,7 +659,7 @@ public class SchemaInfo extends SwaggerElement { * Synonym for {@link #addEnum(Object...)}. * * @param _enum The new values to add to the <property>enum</property> property on this bean. - * These can either be individual objects or {@link Collection Collections} of objects. + * These can either be individual objects or {@link Collection Collections} of objects. * @return This object (for method chaining). */ public SchemaInfo _enum(Object..._enum) { @@ -750,7 +750,7 @@ public class SchemaInfo extends SwaggerElement { * Bean property adder: <property>enum</property>. * * @param allOf The new values to add to the <property>allOf</property> property on this bean. - * These can either be individual objects or {@link Collection Collections} of objects. + * These can either be individual objects or {@link Collection Collections} of objects. * @return This object (for method chaining). */ public SchemaInfo addAllOf(Object...allOf) { @@ -772,7 +772,7 @@ public class SchemaInfo extends SwaggerElement { * Synonym for {@link #addAllOf(Object...)}. * * @param allOf The new values to add to the <property>allOf</property> property on this bean. - * These can either be individual objects or {@link Collection Collections} of objects. + * These can either be individual objects or {@link Collection Collections} of objects. * @return This object (for method chaining). */ public SchemaInfo allOf(Object...allOf) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java b/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java index 6f7c488..933bc07 100644 --- a/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java +++ b/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java @@ -19,9 +19,9 @@ import java.io.*; * * <h5 class='section'>Description:</h5> * <p> - * Used to wrap input and output streams withing compression/decompression streams. + * Used to wrap input and output streams withing compression/decompression streams. * <p> - * Encoders are registered with <code>RestServlets</code> through the <ja>@RestResource.encoders()</ja> annotation. + * Encoders are registered with <code>RestServlets</code> through the <ja>@RestResource.encoders()</ja> annotation. */ public abstract class Encoder { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java b/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java index 4f437c4..4bf4e03 100644 --- a/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java +++ b/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java @@ -26,20 +26,20 @@ import org.apache.juneau.serializer.*; * * <h5 class='section'>Description:</h5> * <p> - * Maintains a set of encoders and the codings that they can handle. + * Maintains a set of encoders and the codings that they can handle. * <p> - * The {@link #getEncoderMatch(String)} and {@link #getEncoder(String)} methods are then - * used to find appropriate encoders for specific <code>Accept-Encoding</code> - * and <code>Content-Encoding</code> header values. + * The {@link #getEncoderMatch(String)} and {@link #getEncoder(String)} methods are then + * used to find appropriate encoders for specific <code>Accept-Encoding</code> + * and <code>Content-Encoding</code> header values. * * <h6 class='topic'>Match ordering</h6> * <p> - * Encoders are matched against <code>Accept-Encoding</code> strings in the order they exist in this group. + * Encoders are matched against <code>Accept-Encoding</code> strings in the order they exist in this group. * <p> - * Adding new entries will cause the entries to be prepended to the group. - * This allows for previous encoders to be overridden through subsequent calls. + * Adding new entries will cause the entries to be prepended to the group. + * This allows for previous encoders to be overridden through subsequent calls. * <p> - * For example, calling <code>g.append(E1.<jk>class</jk>,E2.<jk>class</jk>).append(E3.<jk>class</jk>,E4.<jk>class</jk>)</code> + * For example, calling <code>g.append(E1.<jk>class</jk>,E2.<jk>class</jk>).append(E3.<jk>class</jk>,E4.<jk>class</jk>)</code> * will result in the order <code>E3, E4, E1, E2</code>. * * <h5 class='section'>Example:</h5> @@ -122,9 +122,9 @@ public final class EncoderGroup extends Lockable { * Returns the coding string for the matching encoder that can handle the specified <code>Accept-Encoding</code> * or <code>Content-Encoding</code> header value. * <p> - * Returns <jk>null</jk> if no encoders can handle it. + * Returns <jk>null</jk> if no encoders can handle it. * <p> - * This method is fully compliant with the RFC2616/14.3 and 14.11 specifications. + * This method is fully compliant with the RFC2616/14.3 and 14.11 specifications. * * @param acceptEncoding The <code>Accept-Encoding</code> or <code>Content-Encoding</code> value. * @return The coding value (e.g. <js>"gzip"</js>). http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java index ac79d08..6428d8a 100644 --- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java +++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java @@ -26,18 +26,18 @@ import org.apache.juneau.serializer.*; * * <h5 class='section'>Media types:</h5> * <p> - * Handles <code>Accept</code> types: <code>text/html</code> + * Handles <code>Accept</code> types: <code>text/html</code> * <p> - * Produces <code>Content-Type</code> types: <code>text/html</code> + * Produces <code>Content-Type</code> types: <code>text/html</code> * * <h5 class='section'>Description:</h5> * <p> - * Same as {@link HtmlSerializer}, except wraps the response in <code><xt><html></code>, <code><xt><head></code>, + * Same as {@link HtmlSerializer}, except wraps the response in <code><xt><html></code>, <code><xt><head></code>, * and <code><xt><body></code> tags so that it can be rendered in a browser. * * <h5 class='section'>Configurable properties:</h5> * <p> - * This class has the following properties associated with it: + * This class has the following properties associated with it: * <ul> * <li>{@link HtmlDocSerializerContext} * <li>{@link BeanContext} http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java index 57f10db..56f6fb6 100644 --- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java +++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java @@ -19,8 +19,8 @@ import org.apache.juneau.*; /** * Properties associated with the {@link HtmlDocSerializer} class. * <p> - * These are typically specified via <ja>@RestResource.properties()</ja> and <ja>@RestMethod.properties()</ja> annotations, - * although they can also be set programmatically via the <code>RestResponse.setProperty()</code> method. + * These are typically specified via <ja>@RestResource.properties()</ja> and <ja>@RestMethod.properties()</ja> annotations, + * although they can also be set programmatically via the <code>RestResponse.setProperty()</code> method. * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -35,10 +35,9 @@ import org.apache.juneau.*; * <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault { * </p> * <p> - * The <code>$L{...}</code> variable represent localized strings pulled from the resource bundle identified by the <code>messages</code> annotation. - * These variables are replaced at runtime based on the HTTP request locale. - * Several built-in runtime variable types are defined, and the API can be extended to include user-defined variables. - * </p> + * The <code>$L{...}</code> variable represent localized strings pulled from the resource bundle identified by the <code>messages</code> annotation. + * These variables are replaced at runtime based on the HTTP request locale. + * Several built-in runtime variable types are defined, and the API can be extended to include user-defined variables. * * <h5 class='section'>Inherited configurable properties:</h5> * <ul class='javahierarchy'> @@ -66,7 +65,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext { * * <h5 class='section'>Example:</h5> * <p> - * The <code>AddressBookResource</code> sample class uses this property... + * The <code>AddressBookResource</code> sample class uses this property... * </p> * <p class='bcode'> * <ja>@RestResource</ja>( @@ -103,7 +102,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext { * * <h5 class='section'>Example:</h5> * <p> - * The <code>AddressBookResource</code> sample class uses this property... + * The <code>AddressBookResource</code> sample class uses this property... * </p> * <p class='bcode'> * <ja>@RestResource</ja>( @@ -123,7 +122,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext { * <p> * ...to produce this description on the HTML page... * </p> - * <img class='bordered' src='doc-files/HTML_DESCRIPTION.png'> + * <img class='bordered' src='doc-files/HTML_DESCRIPTION.png'> */ public static final String HTMLDOC_description = "HtmlSerializer.description"; @@ -139,19 +138,19 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext { * <p> * Adds a list of hyperlinks immediately under the title and description but above the content of the page. * <p> - * This can be used to provide convenient hyperlinks when viewing the REST interface from a browser. + * This can be used to provide convenient hyperlinks when viewing the REST interface from a browser. * <p> - * The value is a JSON object string where the keys are anchor text and the values are URLs. + * The value is a JSON object string where the keys are anchor text and the values are URLs. * <p> - * Relative URLs are considered relative to the servlet path. - * For example, if the servlet path is <js>"http://localhost/myContext/myServlet";</js>, and the - * URL is <js>"foo"</js>, the link becomes <js>"http://localhost/myContext/myServlet/foo";</js>. - * Absolute (<js>"/myOtherContext/foo"</js>) and fully-qualified (<js>"http://localhost2/foo";</js>) URLs - * can also be used. + * Relative URLs are considered relative to the servlet path. + * For example, if the servlet path is <js>"http://localhost/myContext/myServlet";</js>, and the + * URL is <js>"foo"</js>, the link becomes <js>"http://localhost/myContext/myServlet/foo";</js>. + * Absolute (<js>"/myOtherContext/foo"</js>) and fully-qualified (<js>"http://localhost2/foo";</js>) URLs + * can also be used. * * <h5 class='section'>Example:</h5> * <p> - * The <code>AddressBookResource</code> sample class uses this property... + * The <code>AddressBookResource</code> sample class uses this property... * </p> * <p class='bcode'> * <ja>@RestResource</ja>( @@ -186,8 +185,8 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext { * <p> * Adds a link to the specified stylesheet URL. * <p> - * If not specified, defaults to the built-in stylesheet located at <js>"style.css"</js>. - * Note that this stylesheet is controlled by the <code><ja>@RestResource</ja>.stylesheet()</code> annotation. + * If not specified, defaults to the built-in stylesheet located at <js>"style.css"</js>. + * Note that this stylesheet is controlled by the <code><ja>@RestResource</ja>.stylesheet()</code> annotation. */ public static final String HTMLDOC_cssUrl = "HtmlDocSerializer.cssUrl"; http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java index f270030..b4745cd 100644 --- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java +++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java @@ -25,11 +25,9 @@ import org.apache.juneau.serializer.*; /** * Context object that lives for the duration of a single serialization of {@link HtmlSerializer} and its subclasses. * <p> - * See {@link SerializerContext} for details. - * </p> + * See {@link SerializerContext} for details. * <p> - * This class is NOT thread safe. It is meant to be discarded after one-time use. - * </p> + * This class is NOT thread safe. It is meant to be discarded after one-time use. */ public final class HtmlDocSerializerSession extends HtmlSerializerSession { @@ -42,15 +40,15 @@ public final class HtmlDocSerializerSession extends HtmlSerializerSession { * Create a new session using properties specified in the context. * * @param ctx The context creating this session object. - * The context contains all the configuration settings for this object. + * The context contains all the configuration settings for this object. * @param output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types. * @param op The override properties. - * These override any context properties defined in the context. + * These override any context properties defined in the context. * @param javaMethod The java method that called this parser, usually the method in a REST servlet. * @param locale The session locale. - * If <jk>null</jk>, then the locale defined on the context is used. + * If <jk>null</jk>, then the locale defined on the context is used. * @param timeZone The session timezone. - * If <jk>null</jk>, then the timezone defined on the context is used. + * If <jk>null</jk>, then the timezone defined on the context is used. * @param mediaType The session media type (e.g. <js>"application/json"</js>). */ @SuppressWarnings({ "unchecked", "rawtypes" }) http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/html/HtmlLink.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlLink.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlLink.java index e26e135..08c1808 100644 --- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlLink.java +++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlLink.java @@ -20,11 +20,11 @@ import java.lang.annotation.*; /** * Used in conjunction with the {@link HtmlSerializer} class to define hyperlinks. * <p> - * This annotation is applied to classes. + * This annotation is applied to classes. * <p> - * Annotation that can be used to specify that a class has a URL associated with it. + * Annotation that can be used to specify that a class has a URL associated with it. * <p> - * When rendered using the {@link org.apache.juneau.html.HtmlSerializer HtmlSerializer} class, this class will get rendered as a hyperlink like so... + * When rendered using the {@link org.apache.juneau.html.HtmlSerializer HtmlSerializer} class, this class will get rendered as a hyperlink like so... * <p class='code'> * <xt><a</xt> <xa>href</xa>=<xs>'hrefProperty'</xs><xt>></xt>nameProperty<xt></a></xt> * </p> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/html/HtmlParser.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParser.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParser.java index 39705ca..92eb48f 100644 --- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParser.java +++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParser.java @@ -34,17 +34,17 @@ import org.apache.juneau.xml.*; * * <h5 class='section'>Media types:</h5> * <p> - * Handles <code>Content-Type</code> types: <code>text/html</code> + * Handles <code>Content-Type</code> types: <code>text/html</code> * * <h5 class='section'>Description:</h5> * <p> - * See the {@link HtmlSerializer} class for a description of the HTML generated. + * See the {@link HtmlSerializer} class for a description of the HTML generated. * <p> - * This class is used primarily for automated testing of the {@link HtmlSerializer} class. + * This class is used primarily for automated testing of the {@link HtmlSerializer} class. * * <h5 class='section'>Configurable properties:</h5> * <p> - * This class has the following properties associated with it: + * This class has the following properties associated with it: * <ul> * <li>{@link HtmlSerializerContext} * </ul> @@ -59,8 +59,8 @@ public final class HtmlParser extends XmlParser { /* * Reads anything starting at the current event. * <p> - * Precondition: Must be pointing at outer START_ELEMENT. - * Postcondition: Pointing at outer END_ELEMENT. + * Precondition: Must be pointing at outer START_ELEMENT. + * Postcondition: Pointing at outer END_ELEMENT. */ private <T> T parseAnything(HtmlParserSession session, ClassMeta<T> eType, XMLStreamReader r, Object outer, boolean isRoot, BeanPropertyMeta pMeta) throws Exception { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserSession.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserSession.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserSession.java index f885578..5ebef14 100644 --- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserSession.java +++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlParserSession.java @@ -42,7 +42,7 @@ public final class HtmlParserSession extends XmlParserSession { * Create a new session using properties specified in the context. * * @param ctx The context creating this session object. - * The context contains all the configuration settings for this object. + * The context contains all the configuration settings for this object. * @param input The input. Can be any of the following types: * <ul> * <li><jk>null</jk> @@ -52,13 +52,13 @@ public final class HtmlParserSession extends XmlParserSession { * <li>{@link File} containing system encoded text. * </ul> * @param op The override properties. - * These override any context properties defined in the context. + * These override any context properties defined in the context. * @param javaMethod The java method that called this parser, usually the method in a REST servlet. * @param outer The outer object for instantiating top-level non-static inner classes. * @param locale The session locale. - * If <jk>null</jk>, then the locale defined on the context is used. + * If <jk>null</jk>, then the locale defined on the context is used. * @param timeZone The session timezone. - * If <jk>null</jk>, then the timezone defined on the context is used. + * If <jk>null</jk>, then the timezone defined on the context is used. * @param mediaType The session media type (e.g. <js>"application/json"</js>). */ public HtmlParserSession(HtmlParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java index f5b2fa4..0223623 100644 --- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java +++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSchemaDocSerializer.java @@ -27,19 +27,19 @@ import org.apache.juneau.transform.*; * * <h5 class='section'>Media types:</h5> * <p> - * Handles <code>Accept</code> types: <code>text/html+schema</code> + * Handles <code>Accept</code> types: <code>text/html+schema</code> * <p> - * Produces <code>Content-Type</code> types: <code>text/html</code> + * Produces <code>Content-Type</code> types: <code>text/html</code> * * <h5 class='section'>Description:</h5> * <p> - * Essentially the same as {@link HtmlSerializer}, except serializes the POJO metamodel - * instead of the model itself. + * Essentially the same as {@link HtmlSerializer}, except serializes the POJO metamodel + * instead of the model itself. * <p> - * Produces output that describes the POJO metamodel similar to an XML schema document. + * Produces output that describes the POJO metamodel similar to an XML schema document. * <p> - * The easiest way to create instances of this class is through the {@link HtmlSerializer#getSchemaSerializer()}, - * which will create a schema serializer with the same settings as the originating serializer. + * The easiest way to create instances of this class is through the {@link HtmlSerializer#getSchemaSerializer()}, + * which will create a schema serializer with the same settings as the originating serializer. */ @Produces(value="text/html+schema", contentType="text/html") public final class HtmlSchemaDocSerializer extends HtmlDocSerializer { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java index e5d4589..f66d57f 100644 --- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java +++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializer.java @@ -31,13 +31,13 @@ import org.apache.juneau.xml.annotation.*; * * <h5 class='section'>Media types:</h5> * <p> - * Handles <code>Accept</code> types: <code>text/html</code> + * Handles <code>Accept</code> types: <code>text/html</code> * <p> - * Produces <code>Content-Type</code> types: <code>text/html</code> + * Produces <code>Content-Type</code> types: <code>text/html</code> * * <h5 class='section'>Description:</h5> * <p> - * The conversion is as follows... + * The conversion is as follows... * <ul class='spaced-list'> * <li>{@link Map Maps} (e.g. {@link HashMap}, {@link TreeMap}) and beans are converted to HTML tables with 'key' and 'value' columns. * <li>{@link Collection Collections} (e.g. {@link HashSet}, {@link LinkedList}) and Java arrays are converted to HTML ordered lists. @@ -45,21 +45,21 @@ import org.apache.juneau.xml.annotation.*; * <li>Everything else is converted to text. * </ul> * <p> - * This serializer provides several serialization options. Typically, one of the predefined <jsf>DEFAULT</jsf> serializers will be sufficient. - * However, custom serializers can be constructed to fine-tune behavior. + * This serializer provides several serialization options. Typically, one of the predefined <jsf>DEFAULT</jsf> serializers will be sufficient. + * However, custom serializers can be constructed to fine-tune behavior. * <p> - * The {@link HtmlLink} annotation can be used on beans to add hyperlinks to the output. + * The {@link HtmlLink} annotation can be used on beans to add hyperlinks to the output. * * <h5 class='section'>Configurable properties:</h5> * <p> - * This class has the following properties associated with it: + * This class has the following properties associated with it: * <ul class='spaced-list'> * <li>{@link HtmlSerializerContext} * </ul> * * <h6 class='topic'>Behavior-specific subclasses</h6> * <p> - * The following direct subclasses are provided for convenience: + * The following direct subclasses are provided for convenience: * <ul class='spaced-list'> * <li>{@link Sq} - Default serializer, single quotes. * <li>{@link SqReadable} - Default serializer, single quotes, whitespace added. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java index 992067e..1ce2efc 100644 --- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java +++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerSession.java @@ -51,15 +51,15 @@ public class HtmlSerializerSession extends XmlSerializerSession { * Create a new session using properties specified in the context. * * @param ctx The context creating this session object. - * The context contains all the configuration settings for this object. + * The context contains all the configuration settings for this object. * @param output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types. * @param op The override properties. - * These override any context properties defined in the context. + * These override any context properties defined in the context. * @param javaMethod The java method that called this parser, usually the method in a REST servlet. * @param locale The session locale. - * If <jk>null</jk>, then the locale defined on the context is used. + * If <jk>null</jk>, then the locale defined on the context is used. * @param timeZone The session timezone. - * If <jk>null</jk>, then the timezone defined on the context is used. + * If <jk>null</jk>, then the timezone defined on the context is used. * @param mediaType The session media type (e.g. <js>"application/json"</js>). */ protected HtmlSerializerSession(HtmlSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java index 168b648..7efdfa0 100644 --- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java +++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlStrippedDocSerializer.java @@ -23,14 +23,14 @@ import org.apache.juneau.serializer.*; * * <h5 class='section'>Media types:</h5> * <p> - * Handles <code>Accept</code> types: <code>text/html+stripped</code> + * Handles <code>Accept</code> types: <code>text/html+stripped</code> * <p> - * Produces <code>Content-Type</code> types: <code>text/html</code> + * Produces <code>Content-Type</code> types: <code>text/html</code> * * <h5 class='section'>Description:</h5> * <p> - * Produces the same output as {@link HtmlDocSerializer}, but without the header and body tags and page title and description. - * Used primarily for JUnit testing the {@link HtmlDocSerializer} class. + * Produces the same output as {@link HtmlDocSerializer}, but without the header and body tags and page title and description. + * Used primarily for JUnit testing the {@link HtmlDocSerializer} class. */ @Produces(value="text/html+stripped",contentType="text/html") public class HtmlStrippedDocSerializer extends HtmlSerializer { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFile.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFile.java b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFile.java index b55a2ab..d8f18c1 100644 --- a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFile.java +++ b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFile.java @@ -396,8 +396,8 @@ public abstract class ConfigFile implements Map<String,Section> { /** * Adds or replaces an entry with the specified key with a POJO serialized to a string using the registered serializer. - * <p> - * Equivalent to calling <code>put(key, value, isEncoded(key))</code>. + * <p> + * Equivalent to calling <code>put(key, value, isEncoded(key))</code>. * * @param key The key. See {@link #getString(String)} for a description of the key. * @param value The new value POJO. @@ -423,7 +423,7 @@ public abstract class ConfigFile implements Map<String,Section> { * * @param key The key. See {@link #getString(String)} for a description of the key. * @param value The new value. - * @param encoded If <jk>true</jk>, value is encoded by the registered encoder when the config file is persisted to disk. + * @param encoded If <jk>true</jk>, value is encoded by the registered encoder when the config file is persisted to disk. * @return The previous value, or <jk>null</jk> if the section or key did not previously exist. * @throws SerializeException If serializer could not serialize the value or if a serializer is not registered with this config file. * @throws UnsupportedOperationException If config file is read only. @@ -483,7 +483,7 @@ public abstract class ConfigFile implements Map<String,Section> { /** * Copies the entries in a section to the specified bean by calling the public setters on that bean. * - * @param sectionName The section name to write from. + * @param sectionName The section name to write from. * @param bean The bean to set the properties on. * @param ignoreUnknownProperties If <jk>true</jk>, don't throw an {@link IllegalArgumentException} if this section * contains a key that doesn't correspond to a setter method. @@ -542,7 +542,7 @@ public abstract class ConfigFile implements Map<String,Section> { /** * Converts this config file section to the specified bean instance. * - * @param sectionName The section name to write from. + * @param sectionName The section name to write from. * @param c The bean class to create. * @param ignoreUnknownProperties If <jk>false</jk>, throws a {@link ParseException} if * the section contains an entry that isn't a bean property name. @@ -716,9 +716,9 @@ public abstract class ConfigFile implements Map<String,Section> { /** * Returns a wrapped instance of this config file where calls to getters have their values - * first resolved by a default {@link VarResolver}. + * first resolved by a default {@link VarResolver}. * - * The default {@link VarResolver} is registered with the following {@link Var StringVars}: + * The default {@link VarResolver} is registered with the following {@link Var StringVars}: * <ul class='spaced-list'> * <li><code>$S{key}</code>,<code>$S{key,default}</code> - System properties. * <li><code>$E{key}</code>,<code>$E{key,default}</code> - Environment variables. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileImpl.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileImpl.java b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileImpl.java index 8982b81..a4b2f89 100644 --- a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileImpl.java +++ b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileImpl.java @@ -59,17 +59,17 @@ public final class ConfigFileImpl extends ConfigFile { * If file does not initially exist, this object will start off empty. * * @param file The INI file on disk. - * If <jk>null</jk>, create an in-memory config file. + * If <jk>null</jk>, create an in-memory config file. * @param readOnly Make this configuration file read-only. - * Attempting to set any values on this config file will cause {@link UnsupportedOperationException} to be thrown. - * @param encoder The encoder to use for encoding sensitive values in this configuration file. - * If <jk>null</jk>, defaults to {@link XorEncoder#INSTANCE}. - * @param serializer The serializer to use for serializing POJOs in the {@link #put(String, Object)} method. - * If <jk>null</jk>, defaults to {@link JsonSerializer#DEFAULT}. - * @param parser The parser to use for parsing POJOs in the {@link #getObject(Class,String)} method. - * If <jk>null</jk>, defaults to {@link JsonParser#DEFAULT}. + * Attempting to set any values on this config file will cause {@link UnsupportedOperationException} to be thrown. + * @param encoder The encoder to use for encoding sensitive values in this configuration file. + * If <jk>null</jk>, defaults to {@link XorEncoder#INSTANCE}. + * @param serializer The serializer to use for serializing POJOs in the {@link #put(String, Object)} method. + * If <jk>null</jk>, defaults to {@link JsonSerializer#DEFAULT}. + * @param parser The parser to use for parsing POJOs in the {@link #getObject(Class,String)} method. + * If <jk>null</jk>, defaults to {@link JsonParser#DEFAULT}. * @param charset The charset on the files. - * If <jk>null</jk>, defaults to {@link Charset#defaultCharset()}. + * If <jk>null</jk>, defaults to {@link Charset#defaultCharset()}. * @throws IOException */ public ConfigFileImpl(File file, boolean readOnly, Encoder encoder, WriterSerializer serializer, ReaderParser parser, Charset charset) throws IOException { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/internal/ArrayUtils.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/ArrayUtils.java b/juneau-core/src/main/java/org/apache/juneau/internal/ArrayUtils.java index 0bd765a..12c7614 100644 --- a/juneau-core/src/main/java/org/apache/juneau/internal/ArrayUtils.java +++ b/juneau-core/src/main/java/org/apache/juneau/internal/ArrayUtils.java @@ -113,7 +113,7 @@ public final class ArrayUtils { /** * Converts the specified array to a <code>Set</code>. * <p> - * The order of the entries in the set are the same as the array. + * The order of the entries in the set are the same as the array. * * @param <T> The entry type of the array. * @param array The array being wrapped in a <code>Set</code> interface. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/internal/DelegateBeanMap.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/DelegateBeanMap.java b/juneau-core/src/main/java/org/apache/juneau/internal/DelegateBeanMap.java index 940eda3..e490535 100644 --- a/juneau-core/src/main/java/org/apache/juneau/internal/DelegateBeanMap.java +++ b/juneau-core/src/main/java/org/apache/juneau/internal/DelegateBeanMap.java @@ -20,8 +20,8 @@ import org.apache.juneau.*; * Represents a wrapped {@link BeanMap} where property values can be overridden, removed, or reordered * without affecting the underlying bean. * <p> - * Provides the {@link #filterKeys(List)} method for specifying the keys to keep in the bean map - * and in what order they should appear. + * Provides the {@link #filterKeys(List)} method for specifying the keys to keep in the bean map + * and in what order they should appear. * * @param <T> The class type of the wrapped bean. */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/internal/HashCode.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/HashCode.java b/juneau-core/src/main/java/org/apache/juneau/internal/HashCode.java index c8b8f7a..0cc048c 100644 --- a/juneau-core/src/main/java/org/apache/juneau/internal/HashCode.java +++ b/juneau-core/src/main/java/org/apache/juneau/internal/HashCode.java @@ -15,7 +15,7 @@ package org.apache.juneau.internal; /** * Utility class for generating integer hash codes. * <p> - * General usage: + * General usage: * <p class='bcode'> * int hashCode = new HashCode().add("foobar").add(myobject).add(123).get(); * </p> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/internal/IOUtils.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/IOUtils.java b/juneau-core/src/main/java/org/apache/juneau/internal/IOUtils.java index 6821892..254fac9 100644 --- a/juneau-core/src/main/java/org/apache/juneau/internal/IOUtils.java +++ b/juneau-core/src/main/java/org/apache/juneau/internal/IOUtils.java @@ -177,9 +177,9 @@ public final class IOUtils { /** * Reads the specified input into a {@link String} until the end of the input is reached. * <p> - * The {@code Reader} is automatically closed. + * The {@code Reader} is automatically closed. * <p> - * If the {@code Reader} is not an instance of a {@code BufferedReader}, then it gets wrapped in a {@code BufferedReader}. + * If the {@code Reader} is not an instance of a {@code BufferedReader}, then it gets wrapped in a {@code BufferedReader}. * * @param in The input reader. * @param length Specify a positive number if the length of the input is known. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/internal/JuneauLogger.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/JuneauLogger.java b/juneau-core/src/main/java/org/apache/juneau/internal/JuneauLogger.java index b2a1e29..021e4c3 100644 --- a/juneau-core/src/main/java/org/apache/juneau/internal/JuneauLogger.java +++ b/juneau-core/src/main/java/org/apache/juneau/internal/JuneauLogger.java @@ -56,12 +56,12 @@ public class JuneauLogger extends java.util.logging.Logger { * * @param forClass The class to create a logger for. * @param resourceBundleName The name of the resource bundle. - * Can be any of the following formats: - * <ol> - * <li>An absolute path. E.g. <js>"com/foo/nls/Messages"</js>. - * <li>A path relative to the package of the class. E.g. <js>"nls/Messages"</js>. - * </ol> - * Both <js>'.'</js> and <js>'/'</js> can be used as path delimiters. + * Can be any of the following formats: + * <ol> + * <li>An absolute path. E.g. <js>"com/foo/nls/Messages"</js>. + * <li>A path relative to the package of the class. E.g. <js>"nls/Messages"</js>. + * </ol> + * Both <js>'.'</js> and <js>'/'</js> can be used as path delimiters. * @return A new <l>Logger</l>. */ public static JuneauLogger getLogger(Class<?> forClass, String resourceBundleName) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/internal/ReflectionUtils.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/ReflectionUtils.java b/juneau-core/src/main/java/org/apache/juneau/internal/ReflectionUtils.java index 06f6c33..0a0c602 100644 --- a/juneau-core/src/main/java/org/apache/juneau/internal/ReflectionUtils.java +++ b/juneau-core/src/main/java/org/apache/juneau/internal/ReflectionUtils.java @@ -54,7 +54,7 @@ public final class ReflectionUtils { /** * Returns the specified annotation only if it's been declared on the specified class. * <p> - * More efficient than calling {@link Class#getAnnotation(Class)} since it doesn't + * More efficient than calling {@link Class#getAnnotation(Class)} since it doesn't * recursively look for the class up the parent chain. * * @param <T> The annotation class type. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/internal/SimpleMap.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/SimpleMap.java b/juneau-core/src/main/java/org/apache/juneau/internal/SimpleMap.java index 287c2df..93d9b74 100644 --- a/juneau-core/src/main/java/org/apache/juneau/internal/SimpleMap.java +++ b/juneau-core/src/main/java/org/apache/juneau/internal/SimpleMap.java @@ -22,11 +22,11 @@ import java.util.*; * An instance of a <code>Map</code> where the keys and values * are simple <code>String[]</code> and <code>Object[]</code> arrays. * <p> - * Typically more efficient than <code>HashMaps</code> for small maps (e.g. <10 entries). + * Typically more efficient than <code>HashMaps</code> for small maps (e.g. <10 entries). * <p> - * Does not support adding or removing entries. + * Does not support adding or removing entries. * <p> - * Setting values overwrites the value on the underlying value array. + * Setting values overwrites the value on the underlying value array. */ public final class SimpleMap extends AbstractMap<String,Object> { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/internal/StringUtils.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/StringUtils.java b/juneau-core/src/main/java/org/apache/juneau/internal/StringUtils.java index 0831df4..8d8fe73 100644 --- a/juneau-core/src/main/java/org/apache/juneau/internal/StringUtils.java +++ b/juneau-core/src/main/java/org/apache/juneau/internal/StringUtils.java @@ -52,18 +52,18 @@ public final class StringUtils { * * @param r The reader to parse the string from. * @param type The number type to created. <br> - * Can be any of the following: - * <ul> - * <li> Integer - * <li> Double - * <li> Float - * <li> Long - * <li> Short - * <li> Byte - * <li> BigInteger - * <li> BigDecimal - * </ul> - * If <jk>null</jk>, uses the best guess. + * Can be any of the following: + * <ul> + * <li> Integer + * <li> Double + * <li> Float + * <li> Long + * <li> Short + * <li> Byte + * <li> BigInteger + * <li> BigDecimal + * </ul> + * If <jk>null</jk>, uses the best guess. * @throws IOException If a problem occurred trying to read from the reader. * @return The parsed number. * @throws Exception @@ -99,18 +99,18 @@ public final class StringUtils { * * @param s The string to parse the number from. * @param type The number type to created. <br> - * Can be any of the following: - * <ul> - * <li> Integer - * <li> Double - * <li> Float - * <li> Long - * <li> Short - * <li> Byte - * <li> BigInteger - * <li> BigDecimal - * </ul> - * If <jk>null</jk>, uses the best guess. + * Can be any of the following: + * <ul> + * <li> Integer + * <li> Double + * <li> Float + * <li> Long + * <li> Short + * <li> Byte + * <li> BigInteger + * <li> BigDecimal + * </ul> + * If <jk>null</jk>, uses the best guess. * @return The parsed number. * @throws ParseException */ @@ -854,8 +854,8 @@ public final class StringUtils { * Nested variables are supported in both the input string and map values. * <p> * If the map does not contain the specified value, the variable is not replaced. - * <p> - * <jk>null</jk> values in the map are treated as blank strings. + * <p> + * <jk>null</jk> values in the map are treated as blank strings. * * @param s The string containing variables to replace. * @param m The map containing the variable values. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/internal/Utils.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/Utils.java b/juneau-core/src/main/java/org/apache/juneau/internal/Utils.java index d97e76e..7e15972 100644 --- a/juneau-core/src/main/java/org/apache/juneau/internal/Utils.java +++ b/juneau-core/src/main/java/org/apache/juneau/internal/Utils.java @@ -27,8 +27,8 @@ public class Utils { * <code>0</code> if Integer #1 numerically less * than Integer #2; and a value greater * than <code>0</code> if Integer #1 is numerically - * greater than Integer #2 (signed - * comparison). + * greater than Integer #2 (signed + * comparison). */ public static final int compare(int i1, int i2) { return (i1<i2 ? -1 : (i1==i2 ? 0 : 1)); http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/internal/Version.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/Version.java b/juneau-core/src/main/java/org/apache/juneau/internal/Version.java index 33530c7..942043e 100644 --- a/juneau-core/src/main/java/org/apache/juneau/internal/Version.java +++ b/juneau-core/src/main/java/org/apache/juneau/internal/Version.java @@ -34,7 +34,7 @@ public class Version { * <li><js>"0.1"</js> * <li><js>".1"</js> * </ul> - * Any parts that are not numeric are interpreted as {@link Integer#MAX_VALUE} + * Any parts that are not numeric are interpreted as {@link Integer#MAX_VALUE} */ public Version(String versionString) { if (isEmpty(versionString)) http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/internal/VersionRange.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/VersionRange.java b/juneau-core/src/main/java/org/apache/juneau/internal/VersionRange.java index 4c61e88..3321f2d 100644 --- a/juneau-core/src/main/java/org/apache/juneau/internal/VersionRange.java +++ b/juneau-core/src/main/java/org/apache/juneau/internal/VersionRange.java @@ -15,7 +15,7 @@ package org.apache.juneau.internal; /** * Represents an OSGi-style version range like <js>"1.2"</js> or <js>"[1.0,2.0)"</js>. * <p> - * The range can be any of the following formats: + * The range can be any of the following formats: * <ul> * <li><js>"[0,1.0)"</js> = Less than 1.0. 1.0 and 1.0.0 does not match. * <li><js>"[0,1.0]"</js> = Less than or equal to 1.0. Note that 1.0.1 will match. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/jso/JavaSerializedObjectParser.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/jso/JavaSerializedObjectParser.java b/juneau-core/src/main/java/org/apache/juneau/jso/JavaSerializedObjectParser.java index 88cc42b..92181bc 100644 --- a/juneau-core/src/main/java/org/apache/juneau/jso/JavaSerializedObjectParser.java +++ b/juneau-core/src/main/java/org/apache/juneau/jso/JavaSerializedObjectParser.java @@ -23,7 +23,7 @@ import org.apache.juneau.parser.*; * * <h5 class='section'>Media types:</h5> * <p> - * Consumes <code>Content-Type</code> types: <code>application/x-java-serialized-object</code> + * Consumes <code>Content-Type</code> types: <code>application/x-java-serialized-object</code> */ @Consumes("application/x-java-serialized-object") public final class JavaSerializedObjectParser extends InputStreamParser { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/jso/JavaSerializedObjectSerializer.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/jso/JavaSerializedObjectSerializer.java b/juneau-core/src/main/java/org/apache/juneau/jso/JavaSerializedObjectSerializer.java index 1e1e8e8..4cfde6a 100644 --- a/juneau-core/src/main/java/org/apache/juneau/jso/JavaSerializedObjectSerializer.java +++ b/juneau-core/src/main/java/org/apache/juneau/jso/JavaSerializedObjectSerializer.java @@ -22,9 +22,9 @@ import org.apache.juneau.serializer.*; * * <h5 class='section'>Media types:</h5> * <p> - * Handles <code>Accept</code> types: <code>application/x-java-serialized-object</code> + * Handles <code>Accept</code> types: <code>application/x-java-serialized-object</code> * <p> - * Produces <code>Content-Type</code> types: <code>application/x-java-serialized-object</code> + * Produces <code>Content-Type</code> types: <code>application/x-java-serialized-object</code> */ @Produces("application/x-java-serialized-object") public final class JavaSerializedObjectSerializer extends OutputStreamSerializer { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/json/JsonParser.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonParser.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonParser.java index ac4a096..d8197fc 100644 --- a/juneau-core/src/main/java/org/apache/juneau/json/JsonParser.java +++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonParser.java @@ -27,24 +27,24 @@ import org.apache.juneau.transform.*; * * <h5 class='section'>Media types:</h5> * <p> - * Handles <code>Content-Type</code> types: <code>application/json, text/json</code> + * Handles <code>Content-Type</code> types: <code>application/json, text/json</code> * * <h5 class='section'>Description:</h5> * <p> - * This parser uses a state machine, which makes it very fast and efficient. It parses JSON in about 70% of the + * This parser uses a state machine, which makes it very fast and efficient. It parses JSON in about 70% of the * time that it takes the built-in Java DOM parsers to parse equivalent XML. * <p> - * This parser handles all valid JSON syntax. - * In addition, when strict mode is disable, the parser also handles the following: + * This parser handles all valid JSON syntax. + * In addition, when strict mode is disable, the parser also handles the following: * <ul class='spaced-list'> * <li> Javascript comments (both {@code /*} and {@code //}) are ignored. * <li> Both single and double quoted strings. * <li> Automatically joins concatenated strings (e.g. <code><js>"aaa"</js> + <js>'bbb'</js></code>). * <li> Unquoted attributes. * </ul> - * Also handles negative, decimal, hexadecimal, octal, and double numbers, including exponential notation. + * Also handles negative, decimal, hexadecimal, octal, and double numbers, including exponential notation. * <p> - * This parser handles the following input, and automatically returns the corresponding Java class. + * This parser handles the following input, and automatically returns the corresponding Java class. * <ul class='spaced-list'> * <li> JSON objects (<js>"{...}"</js>) are converted to {@link ObjectMap ObjectMaps}. <br> * <b>Note:</b> If a <code><xa>_type</xa>=<xs>'xxx'</xs></code> attribute is specified on the object, then an attempt is made to convert the object @@ -59,24 +59,24 @@ import org.apache.juneau.transform.*; * <li> Input consisting of only whitespace or JSON comments are converted to <jk>null</jk>. * </ul> * <p> - * Input can be any of the following:<br> - * <ul class='spaced-list'> - * <li> <js>"{...}"</js> - Converted to a {@link ObjectMap} or an instance of a Java bean if a <xa>_type</xa> attribute is present. - * <li> <js>"[...]"</js> - Converted to a {@link ObjectList}. - * <li> <js>"123..."</js> - Converted to a {@link Number} (either {@link Integer}, {@link Long}, {@link Float}, or {@link Double}). - * <li> <js>"true"</js>/<js>"false"</js> - Converted to a {@link Boolean}. - * <li> <js>"null"</js> - Returns <jk>null</jk>. - * <li> <js>"'xxx'"</js> - Converted to a {@link String}. - * <li> <js>"\"xxx\""</js> - Converted to a {@link String}. - * <li> <js>"'xxx' + \"yyy\""</js> - Converted to a concatenated {@link String}. - * </ul> - * <p> - * TIP: If you know you're parsing a JSON object or array, it can be easier to parse it using the {@link ObjectMap#ObjectMap(CharSequence) ObjectMap(CharSequence)} - * or {@link ObjectList#ObjectList(CharSequence) ObjectList(CharSequence)} constructors instead of using this class. The end result should be the same. + * Input can be any of the following:<br> + * <ul class='spaced-list'> + * <li> <js>"{...}"</js> - Converted to a {@link ObjectMap} or an instance of a Java bean if a <xa>_type</xa> attribute is present. + * <li> <js>"[...]"</js> - Converted to a {@link ObjectList}. + * <li> <js>"123..."</js> - Converted to a {@link Number} (either {@link Integer}, {@link Long}, {@link Float}, or {@link Double}). + * <li> <js>"true"</js>/<js>"false"</js> - Converted to a {@link Boolean}. + * <li> <js>"null"</js> - Returns <jk>null</jk>. + * <li> <js>"'xxx'"</js> - Converted to a {@link String}. + * <li> <js>"\"xxx\""</js> - Converted to a {@link String}. + * <li> <js>"'xxx' + \"yyy\""</js> - Converted to a concatenated {@link String}. + * </ul> + * <p> + * TIP: If you know you're parsing a JSON object or array, it can be easier to parse it using the {@link ObjectMap#ObjectMap(CharSequence) ObjectMap(CharSequence)} + * or {@link ObjectList#ObjectList(CharSequence) ObjectList(CharSequence)} constructors instead of using this class. The end result should be the same. * * <h5 class='section'>Configurable properties:</h5> * <p> - * This class has the following properties associated with it: + * This class has the following properties associated with it: * <ul> * <li>{@link JsonParserContext} * </ul> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/json/JsonParserSession.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonParserSession.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonParserSession.java index 11acf28..6ce9d20 100644 --- a/juneau-core/src/main/java/org/apache/juneau/json/JsonParserSession.java +++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonParserSession.java @@ -33,23 +33,23 @@ public final class JsonParserSession extends ParserSession { * Create a new session using properties specified in the context. * * @param ctx The context creating this session object. - * The context contains all the configuration settings for this object. + * The context contains all the configuration settings for this object. * @param input The input. Can be any of the following types: - * <ul> - * <li><jk>null</jk> - * <li>{@link Reader} - * <li>{@link CharSequence} - * <li>{@link InputStream} containing UTF-8 encoded text. - * <li>{@link File} containing system encoded text. - * </ul> + * <ul> + * <li><jk>null</jk> + * <li>{@link Reader} + * <li>{@link CharSequence} + * <li>{@link InputStream} containing UTF-8 encoded text. + * <li>{@link File} containing system encoded text. + * </ul> * @param op The override properties. - * These override any context properties defined in the context. + * These override any context properties defined in the context. * @param javaMethod The java method that called this parser, usually the method in a REST servlet. * @param outer The outer object for instantiating top-level non-static inner classes. * @param locale The session locale. - * If <jk>null</jk>, then the locale defined on the context is used. + * If <jk>null</jk>, then the locale defined on the context is used. * @param timeZone The session timezone. - * If <jk>null</jk>, then the timezone defined on the context is used. + * If <jk>null</jk>, then the timezone defined on the context is used. * @param mediaType The session media type (e.g. <js>"application/json"</js>). */ public JsonParserSession(JsonParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java index 54aa643..91c4d72 100644 --- a/juneau-core/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java +++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonSchemaSerializer.java @@ -26,13 +26,13 @@ import org.apache.juneau.transform.*; * * <h5 class='section'>Media types:</h5> * <p> - * Handles <code>Accept</code> types: <code>application/json+schema, text/json+schema</code> + * Handles <code>Accept</code> types: <code>application/json+schema, text/json+schema</code> * <p> - * Produces <code>Content-Type</code> types: <code>application/json</code> + * Produces <code>Content-Type</code> types: <code>application/json</code> * * <h5 class='section'>Description:</h5> * <p> - * Produces the JSON-schema for the JSON produced by the {@link JsonSerializer} class with the same properties. + * Produces the JSON-schema for the JSON produced by the {@link JsonSerializer} class with the same properties. */ @Produces(value="application/json+schema,text/json+schema",contentType="application/json") public final class JsonSchemaSerializer extends JsonSerializer { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializer.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializer.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializer.java index cf74e06..35c2b05 100644 --- a/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializer.java +++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializer.java @@ -27,34 +27,34 @@ import org.apache.juneau.transform.*; * * <h5 class='section'>Media types:</h5> * <p> - * Handles <code>Accept</code> types: <code>application/json, text/json</code> + * Handles <code>Accept</code> types: <code>application/json, text/json</code> * <p> - * Produces <code>Content-Type</code> types: <code>application/json</code> + * Produces <code>Content-Type</code> types: <code>application/json</code> * * <h5 class='section'>Description:</h5> * <p> - * The conversion is as follows... - * <ul class='spaced-list'> - * <li>Maps (e.g. {@link HashMap HashMaps}, {@link TreeMap TreeMaps}) are converted to JSON objects. - * <li>Collections (e.g. {@link HashSet HashSets}, {@link LinkedList LinkedLists}) and Java arrays are converted to JSON arrays. - * <li>{@link String Strings} are converted to JSON strings. - * <li>{@link Number Numbers} (e.g. {@link Integer}, {@link Long}, {@link Double}) are converted to JSON numbers. - * <li>{@link Boolean Booleans} are converted to JSON booleans. - * <li>{@code nulls} are converted to JSON nulls. - * <li>{@code arrays} are converted to JSON arrays. - * <li>{@code beans} are converted to JSON objects. - * </ul> + * The conversion is as follows... + * <ul class='spaced-list'> + * <li>Maps (e.g. {@link HashMap HashMaps}, {@link TreeMap TreeMaps}) are converted to JSON objects. + * <li>Collections (e.g. {@link HashSet HashSets}, {@link LinkedList LinkedLists}) and Java arrays are converted to JSON arrays. + * <li>{@link String Strings} are converted to JSON strings. + * <li>{@link Number Numbers} (e.g. {@link Integer}, {@link Long}, {@link Double}) are converted to JSON numbers. + * <li>{@link Boolean Booleans} are converted to JSON booleans. + * <li>{@code nulls} are converted to JSON nulls. + * <li>{@code arrays} are converted to JSON arrays. + * <li>{@code beans} are converted to JSON objects. + * </ul> * <p> - * The types above are considered "JSON-primitive" object types. Any non-JSON-primitive object types are transformed - * into JSON-primitive object types through {@link org.apache.juneau.transform.PojoSwap PojoSwaps} associated through the {@link CoreApi#addPojoSwaps(Class...)} - * method. Several default transforms are provided for transforming Dates, Enums, Iterators, etc... + * The types above are considered "JSON-primitive" object types. Any non-JSON-primitive object types are transformed + * into JSON-primitive object types through {@link org.apache.juneau.transform.PojoSwap PojoSwaps} associated through the {@link CoreApi#addPojoSwaps(Class...)} + * method. Several default transforms are provided for transforming Dates, Enums, Iterators, etc... * <p> - * This serializer provides several serialization options. Typically, one of the predefined DEFAULT serializers will be sufficient. - * However, custom serializers can be constructed to fine-tune behavior. + * This serializer provides several serialization options. Typically, one of the predefined DEFAULT serializers will be sufficient. + * However, custom serializers can be constructed to fine-tune behavior. * * <h5 class='section'>Configurable properties:</h5> * <p> - * This class has the following properties associated with it: + * This class has the following properties associated with it: * <ul> * <li>{@link JsonSerializerContext} * <li>{@link SerializerContext} @@ -63,7 +63,7 @@ import org.apache.juneau.transform.*; * * <h6 class='topic'>Behavior-specific subclasses</h6> * <p> - * The following direct subclasses are provided for convenience: + * The following direct subclasses are provided for convenience: * <ul class='spaced-list'> * <li>{@link Simple} - Default serializer, single quotes, simple mode. * <li>{@link SimpleReadable} - Default serializer, single quotes, simple mode, with whitespace. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerSession.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerSession.java index ebe569a..ec5498f 100644 --- a/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerSession.java +++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonSerializerSession.java @@ -36,15 +36,15 @@ public final class JsonSerializerSession extends SerializerSession { * Create a new session using properties specified in the context. * * @param ctx The context creating this session object. - * The context contains all the configuration settings for this object. + * The context contains all the configuration settings for this object. * @param output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types. * @param op The override properties. - * These override any context properties defined in the context. + * These override any context properties defined in the context. * @param javaMethod The java method that called this parser, usually the method in a REST servlet. * @param locale The session locale. - * If <jk>null</jk>, then the locale defined on the context is used. + * If <jk>null</jk>, then the locale defined on the context is used. * @param timeZone The session timezone. - * If <jk>null</jk>, then the timezone defined on the context is used. + * If <jk>null</jk>, then the timezone defined on the context is used. * @param mediaType The session media type (e.g. <js>"application/json"</js>). */ protected JsonSerializerSession(JsonSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/json/JsonWriter.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/json/JsonWriter.java b/juneau-core/src/main/java/org/apache/juneau/json/JsonWriter.java index 093a4f0..38b923a 100644 --- a/juneau-core/src/main/java/org/apache/juneau/json/JsonWriter.java +++ b/juneau-core/src/main/java/org/apache/juneau/json/JsonWriter.java @@ -77,16 +77,6 @@ public final class JsonWriter extends SerializerWriter { * @throws IOException Should never happen. */ public JsonWriter stringValue(String s) throws IOException { - /* - * Fixes up a Java string so that it can be used as a JSON string.<br> - * Does the following:<br> - * <ul> - * <li> Replaces {@code \r?\n} with {@code \\n}<br> - * <li> Replaces {@code \t} with {@code \\t}<br> - * <li> Replaces {@code '} with {@code \\'}<br> - * <li> Replaces {@code "} with {@code \\"}<br> - * </ul> - */ if (s == null) return this; boolean doConvert = false; http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/json/annotation/Json.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/json/annotation/Json.java b/juneau-core/src/main/java/org/apache/juneau/json/annotation/Json.java index f8ee5d0..3a361ce 100644 --- a/juneau-core/src/main/java/org/apache/juneau/json/annotation/Json.java +++ b/juneau-core/src/main/java/org/apache/juneau/json/annotation/Json.java @@ -20,9 +20,9 @@ import java.lang.annotation.*; /** * Annotation for specifying various JSON options for the JSON serializers and parsers. * <p> - * Can be applied to Java types. + * Can be applied to Java types. * <p> - * Can be used for the following: + * Can be used for the following: * <ul class='spaced-list'> * <li>Wrap bean instances inside wrapper object (e.g. <code>{'wrapperAttr':bean}</code>). * </ul> @@ -36,9 +36,9 @@ public @interface Json { /** * Wraps beans in a JSON object with the specified attribute name. * <p> - * Applies only to {@link ElementType#TYPE}. + * Applies only to {@link ElementType#TYPE}. * <p> - * This annotation can be applied to beans as well as other objects serialized to other types (e.g. strings). + * This annotation can be applied to beans as well as other objects serialized to other types (e.g. strings). * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -48,7 +48,7 @@ public @interface Json { * } * </p> * <p> - * Without the <ja>@Xml</ja> annotations, serializing this bean as JSON would have produced the following... + * Without the <ja>@Xml</ja> annotations, serializing this bean as JSON would have produced the following... * </p> * <p class='bcode'> * { @@ -56,7 +56,7 @@ public @interface Json { * } * </p> * <p> - * With the annotations, serializing this bean as XML produces the following... + * With the annotations, serializing this bean as XML produces the following... * </p> * <p class='bcode'> * { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/ef1ead8e/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java index 08b80e4..358f3d2 100644 --- a/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java +++ b/juneau-core/src/main/java/org/apache/juneau/msgpack/MsgPackParser.java @@ -27,11 +27,11 @@ import org.apache.juneau.transform.*; * * <h5 class='section'>Media types:</h5> * <p> - * Handles <code>Content-Type</code> types: <code>octal/msgpack</code> + * Handles <code>Content-Type</code> types: <code>octal/msgpack</code> * * <h5 class='section'>Configurable properties:</h5> * <p> - * This class has the following properties associated with it: + * This class has the following properties associated with it: * <ul> * <li>{@link MsgPackParserContext} * </ul>
