You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2017/06/28 23:37:27 UTC
[10/11] incubator-juneau git commit: Clean up javadocs
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java b/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
index 27120d1..0b59ca4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/CoreObjectBuilder.java
@@ -210,7 +210,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Beans require no-arg constructors.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireDefaultConstructor"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -241,7 +240,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Beans require {@link Serializable} interface.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSerializable"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -272,7 +270,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Beans require setters for getters.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSettersForGetters"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -300,7 +297,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Beans require at least one property.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beansRequireSomeProperties"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -332,7 +328,6 @@ public abstract class CoreObjectBuilder {
* <b>Configuration property:</b> {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property
* value.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanMapPutReturnsOldValue"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -364,7 +359,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Look for bean constructors with the specified minimum visibility.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanConstructorVisibility"</js>
* <li><b>Data type:</b> {@link Visibility}
@@ -393,7 +387,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Look for bean classes with the specified minimum visibility.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanClassVisibility"</js>
* <li><b>Data type:</b> {@link Visibility}
@@ -422,7 +415,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Look for bean fields with the specified minimum visibility.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanFieldVisibility"</js>
* <li><b>Data type:</b> {@link Visibility}
@@ -452,7 +444,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Look for bean methods with the specified minimum visibility.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.methodVisibility"</js>
* <li><b>Data type:</b> {@link Visibility}
@@ -482,7 +473,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Use Java {@link Introspector} for determining bean properties.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.useJavaBeanIntrospector"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -510,7 +500,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Use interface proxies.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.useInterfaceProxies"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -538,7 +527,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Ignore unknown properties.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreUnknownBeanProperties"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -566,7 +554,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Ignore unknown properties with null values.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreUnknownNullBeanProperties"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -594,7 +581,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Ignore properties without setters.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignorePropertiesWithoutSetters"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -622,7 +608,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Ignore invocation errors on getters.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreInvocationExceptionsOnGetters"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -650,7 +635,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Ignore invocation errors on setters.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.ignoreInvocationExceptionsOnSetters"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -678,7 +662,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Sort bean properties in alphabetical order.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.sortProperties"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -713,7 +696,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Packages whose classes should not be considered beans.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.notBeanPackages.set"</js>
* <li><b>Data type:</b> <code>Set<String></code>
@@ -756,7 +738,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Packages whose classes should not be considered beans.
*
- * <p>
* Same as {@link #setNotBeanPackages(String...)} but using a <code>Collection</code>.
*
* @param values The new value for this property.
@@ -834,7 +815,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Classes to be excluded from consideration as being beans.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.notBeanClasses.set"</js>
* <li><b>Data type:</b> <code>Set<Class></code>
@@ -942,7 +922,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Bean filters to apply to beans.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanFilters.list"</js>
* <li><b>Data type:</b> <code>List<Class></code>
@@ -1064,7 +1043,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> POJO swaps to apply to Java objects.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.pojoSwaps.list"</js>
* <li><b>Data type:</b> <code>List<Class></code>
@@ -1175,7 +1153,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Implementation classes for interfaces and abstract classes.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.implClasses.map"</js>
* <li><b>Data type:</b> <code>Map<Class,Class></code>
@@ -1224,7 +1201,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Explicitly specify visible bean properties.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.includeProperties"</js>
* <li><b>Data type:</b> <code>Map<String,String></code>
@@ -1298,7 +1274,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Exclude specified properties from beans.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.excludeProperties"</js>
* <li><b>Data type:</b> <code>Map<String,String></code>
@@ -1372,7 +1347,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Bean lookup dictionary.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanDictionary.list"</js>
* <li><b>Data type:</b> <code>List<Class></code>
@@ -1486,7 +1460,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Name to use for the bean type properties used to represent a bean type.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.beanTypePropertyName"</js>
* <li><b>Data type:</b> <code>String</code>
@@ -1510,7 +1483,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Default parser to use when converting <code>Strings</code> to POJOs.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.defaultParser"</js>
* <li><b>Data type:</b> <code>Class</code>
@@ -1537,7 +1509,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Locale.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.locale"</js>
* <li><b>Data type:</b> <code>Locale</code>
@@ -1561,7 +1532,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> TimeZone.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.timeZone"</js>
* <li><b>Data type:</b> <code>TimeZone</code>
@@ -1585,7 +1555,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Media type.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.mediaType"</js>
* <li><b>Data type:</b> <code>MediaType</code>
@@ -1612,7 +1581,6 @@ public abstract class CoreObjectBuilder {
/**
* <b>Configuration property:</b> Debug mode.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"BeanContext.debug"</js>
* <li><b>Data type:</b> <code>Boolean</code>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java b/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
index 26961d9..b03dfb4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
+++ b/juneau-core/src/main/java/org/apache/juneau/PropertyStore.java
@@ -44,7 +44,7 @@ import org.apache.juneau.parser.*;
* </ul>
*
* <h6 class='topic'>PropertyStore objects</h6>
- * <p>
+ *
* Property stores can be thought of as consisting of the following:
* <ul>
* <li>A <code>Map<String,Object></code> of context properties.
@@ -66,7 +66,7 @@ import org.apache.juneau.parser.*;
* etc... and can thus be used to retrieve context objects for those serializers.
*
* <h6 class='topic'>Context properties</h6>
- * <p>
+ *
* Context properties are 'settings' for serializers and parsers.
* <br>For example, the {@link BeanContext#BEAN_sortProperties} context property defines whether bean properties should be
* serialized in alphabetical order.
@@ -212,7 +212,7 @@ import org.apache.juneau.parser.*;
* As a general rule, only {@link Context} objects will use these read methods.
*
* <h6 class='topic'>Context objects</h6>
- * <p>
+ *
* A Context object can be thought of as unmodifiable snapshot of a store.
* <br>They should be 'fast' by avoiding synchronization by using final fields whenever possible.
* <br>However, they MUST be thread safe.
@@ -239,7 +239,7 @@ import org.apache.juneau.parser.*;
* </p>
*
* <h6 class='topic'>Session objects</h6>
- * <p>
+ *
* Session objects are created through {@link Context} objects, typically through a <code>createContext()</code> method.
* <br>Unlike context objects, they are NOT reusable and NOT thread safe.
* <br>They are meant to be used one time and then thrown away.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/annotation/Consumes.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/Consumes.java b/juneau-core/src/main/java/org/apache/juneau/annotation/Consumes.java
index e4051ef..835005d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/Consumes.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/Consumes.java
@@ -23,7 +23,7 @@ import org.apache.juneau.parser.*;
* Annotation used on subclasses of {@link Parser} to identify the media types that it consumes.
*
* <h5 class='section'>Description:</h5>
- * <p>
+ *
* Provides a way to define the contents of {@link Parser#getMediaTypes()} through an annotation.
*
* <p>
@@ -32,7 +32,7 @@ import org.apache.juneau.parser.*;
* overridden by subclasses to return the media types programmatically.
*
* <h5 class='section'>Example:</h5>
- * <p>
+ *
* Standard example:
* <p class='bcode'>
* <ja>@Consumes</ja>(<js>"application/json,text/json"</js>)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java b/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java
index cf705e7..1bbb37e 100644
--- a/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java
+++ b/juneau-core/src/main/java/org/apache/juneau/annotation/Produces.java
@@ -23,7 +23,7 @@ import org.apache.juneau.serializer.*;
* Annotation used on subclasses of {@link Serializer} to identify the media types that it produces.
*
* <h5 class='section'>Description:</h5>
- * <p>
+ *
* Provides a way to define the contents of {@link Serializer#getMediaTypes()} through an annotation.
*
* <p>
@@ -32,7 +32,7 @@ import org.apache.juneau.serializer.*;
* be overridden by subclasses to return the media types programmatically.
*
* <h5 class='section'>Example:</h5>
- * <p>
+ *
* Standard example:
* <p class='bcode'>
* <ja>@Produces</ja>(<js>"application/json,text/json"</js>)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/dto/cognos/DataSet.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/cognos/DataSet.java b/juneau-core/src/main/java/org/apache/juneau/dto/cognos/DataSet.java
index dd3f112..6be8583 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/cognos/DataSet.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/cognos/DataSet.java
@@ -51,7 +51,7 @@ import org.apache.juneau.xml.annotation.*;
* Only 2-dimensional POJOs (arrays or collections of maps or beans) can be serialized to Cognos.
*
* <h5 class='section'>Example:</h5>
- * <p>
+ *
* The construct shown above is a serialized <code>AddressBook</code> object which is a subclass of
* <code>LinkedList<Person></code>.
* The code for generating the XML is as follows...
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 15e774b..35ca3d8 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,7 +19,6 @@ import java.io.*;
*
* <h5 class='section'>Description:</h5>
*
- * <p>
* Used to wrap input and output streams within compression/decompression streams.
*
* <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 c75be25..ec3632a 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
@@ -22,7 +22,6 @@ import org.apache.juneau.http.*;
*
* <h5 class='section'>Description:</h5>
*
- * <p>
* Maintains a set of encoders and the codings that they can handle.
*
* <p>
@@ -30,7 +29,7 @@ import org.apache.juneau.http.*;
* 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.
*
* <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 fc0c7d3..f1be67a 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
@@ -24,18 +24,18 @@ import org.apache.juneau.serializer.*;
* Serializes POJOs to HTTP responses as HTML documents.
*
* <h5 class='section'>Media types:</h5>
- * <p>
+ *
* Handles <code>Accept</code> types: <code>text/html</code>
* <p>
* 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>, and <code><xt><body></code> tags so that it can be rendered in a browser.
+ * <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:
* <ul>
* <li>{@link HtmlDocSerializerContext}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 0668b7c..d8546c1 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
@@ -79,7 +79,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Page title.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.title"</js>
* <li><b>Data type:</b> <code>String</code>
@@ -139,7 +138,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Page description.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.description"</js>
* <li><b>Data type:</b> <code>String</code>
@@ -203,7 +201,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Page branding.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.branding"</js>
* <li><b>Data type:</b> <code>String</code>
@@ -223,7 +220,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Header section contents.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.header"</js>
* <li><b>Data type:</b> <code>String</code>
@@ -256,7 +252,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Page links.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.links.map"</js>
* <li><b>Data type:</b> <code>Map<String,String></code>
@@ -322,7 +317,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Nav section contents.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.nav"</js>
* <li><b>Data type:</b> <code>String</code>
@@ -354,7 +348,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Aside section contents.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.aside"</js>
* <li><b>Data type:</b> <code>String</code>
@@ -387,7 +380,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Footer section contents.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.footer"</js>
* <li><b>Data type:</b> <code>String</code>
@@ -418,7 +410,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> No-results message.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.noResultsMessage"</js>
* <li><b>Data type:</b> <code>String</code>
@@ -446,7 +437,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Prevent word wrap on page.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.nowrap"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -462,7 +452,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Stylesheet URL.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.cssUrl"</js>
* <li><b>Data type:</b> <code>String</code>
@@ -485,7 +474,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> CSS code.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.css.list"</js>
* <li><b>Data type:</b> <code>List<String></code>
@@ -526,7 +514,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> HTML document template.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.template"</js>
* <li><b>Data type:</b> <code>Class<? <jk>extends</jk> HtmlDocTemplate></code> or {@link HtmlDocTemplate}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 093c411..cbb3120 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
@@ -33,17 +33,17 @@ import org.apache.juneau.xml.*;
* Parses text generated by the {@link HtmlSerializer} class back into a POJO model.
*
* <h5 class='section'>Media types:</h5>
- * <p>
+ *
* 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.
* <p>
* 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:
* <ul>
* <li>{@link HtmlSerializerContext}
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 d4fcdd6..0c50698 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
@@ -28,14 +28,14 @@ import org.apache.juneau.transform.*;
* Serializes POJO metamodels to HTML.
*
* <h5 class='section'>Media types:</h5>
- * <p>
+ *
* Handles <code>Accept</code> types: <code>text/html+schema</code>
*
* <p>
* 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.
*
* <p>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 22805bd..a6046bf 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
@@ -32,14 +32,14 @@ import org.apache.juneau.xml.annotation.*;
* Serializes POJO models to HTML.
*
* <h5 class='section'>Media types:</h5>
- * <p>
+ *
* Handles <code>Accept</code> types: <code>text/html</code>
*
* <p>
* Produces <code>Content-Type</code> types: <code>text/html</code>
*
* <h5 class='section'>Description:</h5>
- * <p>
+ *
* The conversion is as follows...
* <ul class='spaced-list'>
* <li>
@@ -63,7 +63,7 @@ import org.apache.juneau.xml.annotation.*;
* 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:
* <ul class='spaced-list'>
* <li>
@@ -71,7 +71,7 @@ import org.apache.juneau.xml.annotation.*;
* </ul>
*
* <h6 class='topic'>Behavior-specific subclasses</h6>
- * <p>
+ *
* The following direct subclasses are provided for convenience:
* <ul class='spaced-list'>
* <li>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
index 0633abd..66df425 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerBuilder.java
@@ -55,7 +55,6 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* <b>Configuration property:</b> Anchor text source.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.uriAnchorText"</js>
* <li><b>Data type:</b> <code>String</code>
@@ -101,7 +100,6 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* <b>Configuration property:</b> Look for URLs in {@link String Strings}.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.detectLinksInStrings"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -130,7 +128,6 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* <b>Configuration property:</b> Look for link labels in the <js>"label"</js> parameter of the URL.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.lookForLabelParameters"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -161,7 +158,6 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* <b>Configuration property:</b> The parameter name to use when using {@link HtmlSerializerContext#HTML_lookForLabelParameters}.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.labelParameter"</js>
* <li><b>Data type:</b> <code>String</code>
@@ -186,7 +182,6 @@ public class HtmlSerializerBuilder extends XmlSerializerBuilder {
/**
* <b>Configuration property:</b> Add key/value headers on bean/map tables.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.addKeyValueTableHeaders"</js>
* <li><b>Data type:</b> <code>Boolean</code>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java
index cbead45..a9f34b5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlSerializerContext.java
@@ -44,7 +44,6 @@ public class HtmlSerializerContext extends XmlSerializerContext {
/**
* <b>Configuration property:</b> Anchor text source.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.uriAnchorText"</js>
* <li><b>Data type:</b> <code>String</code>
@@ -90,7 +89,6 @@ public class HtmlSerializerContext extends XmlSerializerContext {
/**
* <b>Configuration property:</b> Look for URLs in {@link String Strings}.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.detectLinksInStrings"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -107,7 +105,6 @@ public class HtmlSerializerContext extends XmlSerializerContext {
/**
* <b>Configuration property:</b> Look for link labels in the <js>"label"</js> parameter of the URL.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.lookForLabelParameters"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -126,7 +123,6 @@ public class HtmlSerializerContext extends XmlSerializerContext {
/**
* <b>Configuration property:</b> The parameter name to use when using {@link #HTML_lookForLabelParameters}.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.labelParameter"</js>
* <li><b>Data type:</b> <code>String</code>
@@ -139,7 +135,6 @@ public class HtmlSerializerContext extends XmlSerializerContext {
/**
* <b>Configuration property:</b> Add key/value headers on bean/map tables.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.addKeyValueTableHeaders"</js>
* <li><b>Data type:</b> <code>Boolean</code>
@@ -152,7 +147,6 @@ public class HtmlSerializerContext extends XmlSerializerContext {
/**
* <b>Configuration property:</b> Add <js>"_type"</js> properties when needed.
*
- * <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.addBeanTypeProperties"</js>
* <li><b>Data type:</b> <code>Boolean</code>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 d73319c..83552c2 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.*;
* Serializes POJOs to HTTP responses as stripped HTML.
*
* <h5 class='section'>Media types:</h5>
- * <p>
+ *
* Handles <code>Accept</code> types: <code>text/html+stripped</code>
*
* <p>
* 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.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java b/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java
index 8e8d47d..7c6531f 100644
--- a/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java
+++ b/juneau-core/src/main/java/org/apache/juneau/http/MediaType.java
@@ -205,7 +205,6 @@ public class MediaType implements Comparable<MediaType> {
/**
* Returns a match metric against the specified media type where a larger number represents a better match.
*
- * <p>
* <ul>
* <li>Exact matches (e.g. <js>"text/json"<js>/</js>"text/json"</js>) should match
* better than meta-character matches (e.g. <js>"text/*"<js>/</js>"text/json"</js>)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 d6d5ad2..1421502 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
@@ -33,6 +33,7 @@ import org.apache.juneau.svl.*;
/**
* Implements the API for accessing the contents of a config file.
+ *
* <p>
* Refer to <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.ini</a> for usage information.
*/
@@ -57,7 +58,8 @@ public abstract class ConfigFile implements Map<String,Section> {
* @param sectionName The section name. Must not be <jk>null</jk>.
* @param sectionKey The section key. Must not be <jk>null</jk>.
* @param value The new value.
- * @param serializer The serializer to use for serializing the object.
+ * @param serializer
+ * The serializer to use for serializing the object.
* If <jk>null</jk>, then uses the predefined serializer on the config file.
* @param encoded If <jk>true</jk>, then encode the value using the encoder associated with this config file.
* @param newline If <jk>true</jk>, then put serialized output on a separate line from the key.
@@ -131,6 +133,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Adds arbitrary lines to the specified config file section.
+ *
* <p>
* The lines can be any of the following....
* <ul class='spaced-list'>
@@ -141,6 +144,7 @@ public abstract class ConfigFile implements Map<String,Section> {
* <li>
* <js>" foobar "</js> - Anything else (interpreted as a comment).
* </ul>
+ *
* <p>
* If the section does not exist, it will automatically be created.
*
@@ -153,10 +157,12 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Adds header comments to the specified section.
+ *
* <p>
* Header comments are defined as lines that start with <jk>"#"</jk> immediately preceding a section header
* <jk>"[section]"</jk>.
* These are handled as part of the section itself instead of being interpreted as comments in the previous section.
+ *
* <p>
* Header comments can be of the following formats...
* <ul class='spaced-list'>
@@ -165,6 +171,7 @@ public abstract class ConfigFile implements Map<String,Section> {
* <li>
* <js>"comment"</js> - Anything else (will automatically be prefixed with <js>"# "</js>).
* </ul>
+ *
* <p>
* If the section does not exist, it will automatically be created.
*
@@ -186,6 +193,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Returns the reusable bean session associated with this config file.
+ *
* <p>
* Used for performing simple datatype conversions.
*
@@ -195,6 +203,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Converts the specified object to a string.
+ *
* <p>
* The serialized output is identical to LAX JSON (JSON with unquoted attributes) except for the following
* exceptions:
@@ -203,7 +212,8 @@ public abstract class ConfigFile implements Map<String,Section> {
* </ul>
*
* @param o The object to serialize.
- * @param serializer The serializer to use for serializing the object.
+ * @param serializer
+ * The serializer to use for serializing the object.
* If <jk>null</jk>, then uses the predefined serializer on the config file.
* @param newline If <jk>true</jk>, add a newline at the beginning of the value.
* @return The serialized object.
@@ -215,7 +225,8 @@ public abstract class ConfigFile implements Map<String,Section> {
* Converts the specified string to an object of the specified type.
*
* @param s The string to parse.
- * @param parser The parser to use for parsing the object.
+ * @param parser
+ * The parser to use for parsing the object.
* If <jk>null</jk>, then uses the predefined parser on the config file.
* @param type The data type to create.
* @param args The generic type arguments if the type is a {@link Collection} or {@link Map}
@@ -266,6 +277,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Gets the entry with the specified key and converts it to the specified value.
+ *
* <p>
* The key can be in one of the following formats...
* <ul class='spaced-list'>
@@ -274,6 +286,7 @@ public abstract class ConfigFile implements Map<String,Section> {
* <li>
* <js>"section/key"</js> - A value from the specified section.
* </ul>
+ *
* <p>
* The type can be a simple type (e.g. beans, strings, numbers) or parameterized type (collections/maps).
*
@@ -299,11 +312,14 @@ public abstract class ConfigFile implements Map<String,Section> {
* Map m = cf.getObject(<js>"MySection/myMapOfListsOfBeans"</js>, TreeMap.<jk>class</jk>, String.<jk>class</jk>,
* List.<jk>class</jk>, MyBean.<jk>class</jk>);
* </p>
+ *
* <p>
* <code>Collection</code> classes are assumed to be followed by zero or one objects indicating the element type.
+ *
* <p>
* <code>Map</code> classes are assumed to be followed by zero or two meta objects indicating the key and value
* types.
+ *
* <p>
* The array can be arbitrarily long to indicate arbitrarily complex data structures.
*
@@ -313,14 +329,15 @@ public abstract class ConfigFile implements Map<String,Section> {
* </ul>
*
* @param key The key. See {@link #getString(String)} for a description of the key.
- * @param type The object type to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
- * {@link GenericArrayType}
- * @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
- * {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
- *
+ * @param type
+ * The object type to create.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * @param args
+ * The type arguments of the class if it's a collection or map.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
* @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.
* @return The value, or <jk>null</jk> if the section or key does not exist.
*/
@@ -332,16 +349,18 @@ public abstract class ConfigFile implements Map<String,Section> {
* Same as {@link #getObject(String, Type, Type...)} but allows you to specify the parser to use to parse the value.
*
* @param key The key. See {@link #getString(String)} for a description of the key.
- * @param parser The parser to use for parsing the object.
- * If <jk>null</jk>, then uses the predefined parser on the config file.
- * @param type The object type to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
- * {@link GenericArrayType}
- * @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
- * {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
- *
+ * @param parser
+ * The parser to use for parsing the object.
+ * If <jk>null</jk>, then uses the predefined parser on the config file.
+ * @param type
+ * The object type to create.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * @param args
+ * The type arguments of the class if it's a collection or map.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
* @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.
* @return The value, or <jk>null</jk> if the section or key does not exist.
*/
@@ -353,6 +372,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Same as {@link #getObject(String, Type, Type...)} except optimized for a non-parameterized class.
+ *
* <p>
* This is the preferred parse method for simple types since you don't need to cast the results.
*
@@ -380,8 +400,8 @@ public abstract class ConfigFile implements Map<String,Section> {
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param type The object type to create.
* @return The parsed object.
- * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified
- * type.
+ * @throws ParseException
+ * If the input contains a syntax error or is malformed, or is not valid for the specified type.
* @see BeanSession#getClassMeta(Type,Type...) for argument syntax for maps and collections.
*/
public final <T> T getObject(String key, Class<T> type) throws ParseException {
@@ -393,12 +413,13 @@ public abstract class ConfigFile implements Map<String,Section> {
*
* @param <T> The class type of the object being created.
* @param key The key. See {@link #getString(String)} for a description of the key.
- * @param parser The parser to use for parsing the object.
- * If <jk>null</jk>, then uses the predefined parser on the config file.
+ * @param parser
+ * The parser to use for parsing the object.
+ * If <jk>null</jk>, then uses the predefined parser on the config file.
* @param type The object type to create.
* @return The parsed object.
- * @throws ParseException If the input contains a syntax error or is malformed, or is not valid for the specified
- * type.
+ * @throws ParseException
+ * If the input contains a syntax error or is malformed, or is not valid for the specified type.
* @see BeanSession#getClassMeta(Type,Type...) for argument syntax for maps and collections.
*/
public final <T> T getObject(String key, Parser parser, Class<T> type) throws ParseException {
@@ -409,13 +430,13 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Gets the entry with the specified key and converts it to the specified value.
+ *
* <p>
* Same as {@link #getObject(String, Class)}, but with a default value.
*
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param def The default value if section or key does not exist.
* @param type The class to convert the value to.
- *
* @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.
* @return The value, or <jk>null</jk> if the section or key does not exist.
*/
@@ -428,11 +449,11 @@ public abstract class ConfigFile implements Map<String,Section> {
* the value.
*
* @param key The key. See {@link #getString(String)} for a description of the key.
- * @param parser The parser to use for parsing the object.
- * If <jk>null</jk>, then uses the predefined parser on the config file.
+ * @param parser
+ * The parser to use for parsing the object.
+ * If <jk>null</jk>, then uses the predefined parser on the config file.
* @param def The default value if section or key does not exist.
* @param type The class to convert the value to.
- *
* @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.
* @return The value, or <jk>null</jk> if the section or key does not exist.
*/
@@ -445,18 +466,21 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Gets the entry with the specified key and converts it to the specified value.
+ *
* <p>
* Same as {@link #getObject(String, Type, Type...)}, but with a default value.
*
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param def The default value if section or key does not exist.
- * @param type The object type to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
- * {@link GenericArrayType}
- * @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
- * {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
+ * @param type
+ * The object type to create.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * @param args
+ * The type arguments of the class if it's a collection or map.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
* @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.
* @return The value, or <jk>null</jk> if the section or key does not exist.
*/
@@ -469,17 +493,19 @@ public abstract class ConfigFile implements Map<String,Section> {
* to parse the value.
*
* @param key The key. See {@link #getString(String)} for a description of the key.
- * @param parser The parser to use for parsing the object.
- * If <jk>null</jk>, then uses the predefined parser on the config file.
+ * @param parser
+ * The parser to use for parsing the object.
+ * If <jk>null</jk>, then uses the predefined parser on the config file.
* @param def The default value if section or key does not exist.
- * @param type The object type to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
- * {@link GenericArrayType}
- * @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
- * {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
- *
+ * @param type
+ * The object type to create.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * @param args
+ * The type arguments of the class if it's a collection or map.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
* @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.
* @return The value, or <jk>null</jk> if the section or key does not exist.
*/
@@ -492,6 +518,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Gets the entry with the specified key and converts it to the specified value.
+ *
* <p>
* Same as {@link #getObject(String, Class)}, but used when key is already broken into section/key.
*
@@ -510,7 +537,8 @@ public abstract class ConfigFile implements Map<String,Section> {
*
* @param sectionName The section name. Must not be <jk>null</jk>.
* @param sectionKey The section key. Must not be <jk>null</jk>.
- * @param parser The parser to use for parsing the object.
+ * @param parser
+ * The parser to use for parsing the object.
* If <jk>null</jk>, then uses the predefined parser on the config file.
* @param c The class to convert the value to.
* @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.
@@ -524,19 +552,21 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Gets the entry with the specified key and converts it to the specified value.
+ *
* <p>
* Same as {@link #getObject(String, Type, Type...)}, but used when key is already broken into section/key.
*
* @param sectionName The section name. Must not be <jk>null</jk>.
* @param sectionKey The section key. Must not be <jk>null</jk>.
- * @param type The object type to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
- * {@link GenericArrayType}
- * @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
- * {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
- *
+ * @param type
+ * The object type to create.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * @param args
+ * The type arguments of the class if it's a collection or map.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
* @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.
* @return The value, or <jk>null</jk> if the section or key does not exist.
*/
@@ -550,15 +580,18 @@ public abstract class ConfigFile implements Map<String,Section> {
*
* @param sectionName The section name. Must not be <jk>null</jk>.
* @param sectionKey The section key. Must not be <jk>null</jk>.
- * @param parser The parser to use for parsing the object.
- * If <jk>null</jk>, then uses the predefined parser on the config file.
- * @param type The object type to create.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
- * {@link GenericArrayType}
- * @param args The type arguments of the class if it's a collection or map.
- * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
- * {@link GenericArrayType}
- * <br>Ignored if the main type is not a map or collection.
+ * @param parser
+ * The parser to use for parsing the object.
+ * If <jk>null</jk>, then uses the predefined parser on the config file.
+ * @param type
+ * The object type to create.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * @param args
+ * The type arguments of the class if it's a collection or map.
+ * <br>Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType},
+ * {@link GenericArrayType}
+ * <br>Ignored if the main type is not a map or collection.
* @throws ParseException If parser could not parse the value or if a parser is not registered with this config file.
* @return The value, or <jk>null</jk> if the section or key does not exist.
*/
@@ -571,6 +604,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Gets the entry with the specified key.
+ *
* <p>
* The key can be in one of the following formats...
* <ul class='spaced-list'>
@@ -624,6 +658,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Convenience method for getting int config values.
+ *
* <p>
* <js>"M"</js> and <js>"K"</js> can be used to identify millions and thousands.
*
@@ -671,14 +706,15 @@ 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>.
*
* @param key The key. See {@link #getString(String)} for a description of the key.
* @param value The new value POJO.
* @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 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.
*/
public final String put(String key, Object value) throws SerializeException {
@@ -690,11 +726,12 @@ 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 POJO.
- * @param serializer The serializer to use for serializing the object.
- * If <jk>null</jk>, then uses the predefined serializer on the config file.
+ * @param serializer
+ * The serializer to use for serializing the object.
+ * If <jk>null</jk>, then uses the predefined serializer on the config file.
* @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 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.
*/
public final String put(String key, Object value, Serializer serializer) throws SerializeException {
@@ -703,6 +740,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Adds or replaces an entry with the specified key with the specified value.
+ *
* <p>
* The format of the entry depends on the data type of the value.
* <ul class='spaced-list'>
@@ -720,11 +758,11 @@ 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 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.
*/
public final String put(String key, Object value, boolean encoded) throws SerializeException {
@@ -737,14 +775,15 @@ 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 serializer The serializer to use for serializing the object.
- * If <jk>null</jk>, then uses the predefined serializer on the config file.
- * @param encoded If <jk>true</jk>, value is encoded by the registered encoder when the config file is persisted
- * to disk.
+ * @param serializer
+ * The serializer to use for serializing the object.
+ * If <jk>null</jk>, then uses the predefined serializer on the config file.
+ * @param encoded
+ * If <jk>true</jk>, value is encoded by the registered encoder when the config file is persisted to disk.
* @param newline If <jk>true</jk>, a newline is added to the beginning of the input.
* @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 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.
*/
public final String put(String key, Object value, Serializer serializer, boolean encoded, boolean newline)
@@ -779,10 +818,12 @@ public abstract class ConfigFile implements Map<String,Section> {
*
* @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.
- * @param permittedPropertyTypes If specified, only look for setters whose property types
- * are those listed. If not specified, use all setters.
+ * @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.
+ * @param permittedPropertyTypes
+ * If specified, only look for setters whose property types are those listed.
+ * If not specified, use all setters.
* @return An object map of the changes made to the bean.
* @throws ParseException If parser was not set on this config file or invalid properties were found in the section.
* @throws IllegalArgumentException
@@ -837,6 +878,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Converts this config file section to the specified bean instance.
+ *
* <p>
* Key/value pairs in the config file section get copied as bean property values to the specified bean class.
*
@@ -867,8 +909,9 @@ public abstract class ConfigFile implements Map<String,Section> {
*
* @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.
+ * @param ignoreUnknownProperties
+ * If <jk>false</jk>, throws a {@link ParseException} if the section contains an entry that isn't a bean property
+ * name.
* @return A new bean instance.
* @throws ParseException
*/
@@ -999,13 +1042,14 @@ public abstract class ConfigFile implements Map<String,Section> {
* @param name The section name.
* @param create Create the section if it's not there.
* @return The section, or <jk>null</jk> if section does not exist.
- * @throws UnsupportedOperationException If config file is read only and section doesn't exist and
- * <code>create</code> is <jk>true</jk>.
+ * @throws UnsupportedOperationException
+ * If config file is read only and section doesn't exist and <code>create</code> is <jk>true</jk>.
*/
protected abstract Section getSection(String name, boolean create);
/**
* Appends a section to this config file if it does not already exist.
+ *
* <p>
* Returns the existing section if it already exists.
*
@@ -1053,6 +1097,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Saves this config file to the specified writer as an INI file.
+ *
* <p>
* The writer will automatically be closed.
*
@@ -1085,6 +1130,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Merges the contents of the specified config file into this config file.
+ *
* <p>
* Pretty much identical to just replacing this config file, but causes the
* {@link ConfigFileListener#onChange(ConfigFile, Set)} method to be invoked on differences between the file.
@@ -1097,6 +1143,7 @@ public abstract class ConfigFile implements Map<String,Section> {
/**
* Returns the config file contents as a string.
+ *
* <p>
* The contents of the string are the same as the contents that would be serialized to disk.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java
index 39baf64..0abbd52 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileBuilder.java
@@ -45,6 +45,7 @@ public class ConfigFileBuilder {
/**
* Specify the encoder to use for encoded config file entries (e.g. <js>"mySecret*={...}"</js>).
+ *
* <p>
* The default value for this setting is an instance of {@link XorEncoder}.
*
@@ -58,6 +59,7 @@ public class ConfigFileBuilder {
/**
* Specify the serializer to use for serializing POJOs when using {@link ConfigFile#put(String, Object)}.
+ *
* <p>
* The default value for this setting is {@link JsonSerializer#DEFAULT_LAX}.
*
@@ -71,6 +73,7 @@ public class ConfigFileBuilder {
/**
* Specify the parser to use for parsing POJOs when using {@link ConfigFile#getObject(String,Class)}.
+ *
* <p>
* The default value for this setting is {@link JsonParser#DEFAULT}
*
@@ -84,6 +87,7 @@ public class ConfigFileBuilder {
/**
* Specify the config file character encoding.
+ *
* <p>
* The default value for this setting is {@link Charset#defaultCharset()}.
*
@@ -97,8 +101,10 @@ public class ConfigFileBuilder {
/**
* Specify the search paths for config files.
+ *
* <p>
* Can contain relative or absolute paths.
+ *
* <p>
* The default value for this setting is <code>[<js>"."</js>]</code>.
*
@@ -114,6 +120,7 @@ public class ConfigFileBuilder {
/**
* Make {@link ConfigFile ConfigFiles} read-only.
+ *
* <p>
* The default value of this setting is <jk>false</jk>.
*
@@ -126,6 +133,7 @@ public class ConfigFileBuilder {
/**
* Create config files if they cannot be found on the file system.
+ *
* <p>
* The default value for this setting is <jk>false</jk>.
*
@@ -160,6 +168,7 @@ public class ConfigFileBuilder {
/**
* Create a new config file backed by the specified file.
+ *
* <p>
* This method is provided primarily for testing purposes.
*
@@ -215,12 +224,13 @@ public class ConfigFileBuilder {
/**
* Implements command-line features for working with INI configuration files.
+ *
* <p>
* Invoke as a normal Java program...
- * <p>
* <p class='bcode'>
* java org.apache.juneau.ini.ConfigFileBuilder [args]
* </p>
+ *
* <p>
* Arguments can be any of the following...
* <ul class='spaced-list'>
@@ -241,6 +251,7 @@ public class ConfigFileBuilder {
* <code>setVals -configFile <configFile> -vals [var1=val1 [var2=val2...]] [-verbose]</code>
* Sets values in config files.
* </ul>
+ *
* <p>
* For example, the following command will create the file <code>'MyConfig.bat'</code> from the contents of the
* file <code>'MyConfig.cfg'</code>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 4235099..5986ebc 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
@@ -56,23 +56,31 @@ public final class ConfigFileImpl extends ConfigFile {
/**
* Constructor.
+ *
* <p>
* Loads the contents of the specified file into this config file.
+ *
* <p>
* 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.
- * @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(String,Class)} 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()}.
+ * @param file
+ * The INI file on disk.
+ * 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(String,Class)} 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()}.
* @throws IOException
*/
public ConfigFileImpl(File file, boolean readOnly, Encoder encoder, WriterSerializer serializer, ReaderParser parser,
@@ -94,6 +102,8 @@ public final class ConfigFileImpl extends ConfigFile {
/**
* Constructor.
+ *
+ * <p>
* Shortcut for calling <code><jk>new</jk> ConfigFileImpl(file, <jk>false</jk>, <jk>null</jk>, <jk>null</jk>,
* <jk>null</jk>, <jk>null</jk>);</code>
*
@@ -106,6 +116,8 @@ public final class ConfigFileImpl extends ConfigFile {
/**
* Constructor.
+ *
+ * <p>
* Shortcut for calling <code><jk>new</jk> ConfigFileImpl(<jk>null</jk>, <jk>false</jk>, <jk>null</jk>,
* <jk>null</jk>, <jk>null</jk>, <jk>null</jk>);</code>
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileListener.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileListener.java b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileListener.java
index 132311d..cfed21a 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileListener.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileListener.java
@@ -16,6 +16,7 @@ import java.util.*;
/**
* Listener that can be used to listen for change events in config files.
+ *
* <p>
* Use the {@link ConfigFile#addListener(ConfigFileListener)} method to register listeners.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileWrapped.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileWrapped.java b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileWrapped.java
index a2a221b..a39f8e8 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileWrapped.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ini/ConfigFileWrapped.java
@@ -25,10 +25,12 @@ import org.apache.juneau.svl.*;
import org.apache.juneau.svl.vars.*;
/**
- * Wraps an instance of {@link ConfigFileImpl} in an interface that will
- * automatically replace {@link VarResolver} variables.
+ * Wraps an instance of {@link ConfigFileImpl} in an interface that will automatically replace {@link VarResolver}
+ * variables.
+ *
* <p>
* The {@link ConfigFile#getResolving(VarResolver)} returns an instance of this class.
+ *
* <p>
* This class overrides the {@link #getString(String, String)} to resolve string variables.
* All other method calls are passed through to the inner config file.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/ini/EntryListener.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ini/EntryListener.java b/juneau-core/src/main/java/org/apache/juneau/ini/EntryListener.java
index 2090f6a..87526c1 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ini/EntryListener.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ini/EntryListener.java
@@ -16,6 +16,7 @@ import java.util.*;
/**
* Listener that can be used to listen for change events for a specific entry in a config file.
+ *
* <p>
* Use the {@link ConfigFile#addListener(ConfigFileListener)} method to register listeners.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/ini/SectionListener.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ini/SectionListener.java b/juneau-core/src/main/java/org/apache/juneau/ini/SectionListener.java
index 4c6c1e4..aec28c1 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ini/SectionListener.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ini/SectionListener.java
@@ -18,6 +18,7 @@ import java.util.*;
/**
* Listener that can be used to listen for change events for a specific section in a config file.
+ *
* <p>
* Use the {@link ConfigFile#addListener(ConfigFileListener)} method to register listeners.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/ini/XorEncoder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ini/XorEncoder.java b/juneau-core/src/main/java/org/apache/juneau/ini/XorEncoder.java
index 0504004..bbd6b3d 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ini/XorEncoder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ini/XorEncoder.java
@@ -17,6 +17,7 @@ import static org.apache.juneau.internal.IOUtils.*;
/**
* Simply XOR+Base64 encoder for obscuring passwords and other sensitive data in INI config files.
+ *
* <p>
* This is not intended to be used as strong encryption.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/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 4609631..760353f 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
@@ -112,6 +112,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.
*
@@ -158,6 +159,8 @@ public final class ArrayUtils {
/**
* Returns an iterator against an array.
+ *
+ * <p>
* This works with any array type (e.g. <code>String[]</code>, <code>Object[]</code>,
* <code><jk>int</jk>[]</code>, etc...).
*
@@ -190,6 +193,8 @@ public final class ArrayUtils {
/**
* Converts the specified collection to an array.
+ *
+ * <p>
* Works on both object and primitive arrays.
*
* @param c The collection to convert to an array.
@@ -219,8 +224,9 @@ public final class ArrayUtils {
* Converts the specified array to an <code>ArrayList</code>
*
* @param array The array to convert.
- * @param componentType The type of objects in the array.
- * It must match the actual component type in the array.
+ * @param componentType
+ * The type of objects in the array.
+ * It must match the actual component type in the array.
* @return A new {@link ArrayList}
*/
@SuppressWarnings("unchecked")
@@ -250,6 +256,8 @@ public final class ArrayUtils {
/**
* Copies the specified array into the specified list.
+ *
+ * <p>
* Works on both object and primitive arrays.
*
* @param array The array to copy into a list.
@@ -267,12 +275,13 @@ public final class ArrayUtils {
}
/**
- * Returns <jk>true</jk> if the specified array contains the specified element using the
- * {@link Object#equals(Object)} method.
+ * Returns <jk>true</jk> if the specified array contains the specified element using the {@link Object#equals(Object)}
+ * method.
*
* @param element The element to check for.
* @param array The array to check.
- * @return <jk>true</jk> if the specified array contains the specified element,
+ * @return
+ * <jk>true</jk> if the specified array contains the specified element,
* <jk>false</jk> if the array or element is <jk>null</jk>.
*/
public static <T> boolean contains(T element, T[] array) {
@@ -284,8 +293,9 @@ public final class ArrayUtils {
*
* @param element The element to check for.
* @param array The array to check.
- * @return The index position of the element in the specified array, or
- * <code>-1</code> if the array doesn't contain the element, or the array or element is <jk>null</jk>.
+ * @return
+ * The index position of the element in the specified array, or <code>-1</code> if the array doesn't contain the
+ * element, or the array or element is <jk>null</jk>.
*/
public static <T> int indexOf(T element, T[] array) {
if (element == null)
@@ -299,13 +309,14 @@ public final class ArrayUtils {
}
/**
- * Returns <jk>true</jk> if the specified array contains the specified element using the
- * {@link String#equals(Object)} method.
+ * Returns <jk>true</jk> if the specified array contains the specified element using the {@link String#equals(Object)}
+ * method.
*
* @param element The element to check for.
* @param array The array to check.
- * @return <jk>true</jk> if the specified array contains the specified element,
- * <jk>false</jk> if the array or element is <jk>null</jk>.
+ * @return
+ * <jk>true</jk> if the specified array contains the specified element,
+ * <jk>false</jk> if the array or element is <jk>null</jk>.
*/
public static boolean contains(String element, String[] array) {
return indexOf(element, array) != -1;
@@ -316,8 +327,9 @@ public final class ArrayUtils {
*
* @param element The element to check for.
* @param array The array to check.
- * @return The index position of the element in the specified array, or
- * <code>-1</code> if the array doesn't contain the element, or the array or element is <jk>null</jk>.
+ * @return
+ * The index position of the element in the specified array, or
+ * <code>-1</code> if the array doesn't contain the element, or the array or element is <jk>null</jk>.
*/
public static int indexOf(String element, String[] array) {
if (element == null)
@@ -331,8 +343,7 @@ public final class ArrayUtils {
}
/**
- * Converts a primitive wrapper array (e.g. <code>Integer[]</code>) to a primitive array (e.g.
- * <code><jk>int</jk>[]</code>).
+ * Converts a primitive wrapper array (e.g. <code>Integer[]</code>) to a primitive array (e.g. <code><jk>int</jk>[]</code>).
*
* @param o The array to convert. Must be a primitive wrapper array.
* @return A new array.
@@ -370,8 +381,9 @@ public final class ArrayUtils {
* Returns the first object in the specified collection or array.
*
* @param val The collection or array object.
- * @return The first object, or <jk>null</jk> if the collection or array is empty or <jk>null</jk> or the value
- * isn't a collection or array.
+ * @return
+ * The first object, or <jk>null</jk> if the collection or array is empty or <jk>null</jk> or the value
+ * isn't a collection or array.
*/
public static Object getFirst(Object val) {
if (val != null) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/internal/ByteArrayCache.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/ByteArrayCache.java b/juneau-core/src/main/java/org/apache/juneau/internal/ByteArrayCache.java
index 93b9b67..0dde655 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/ByteArrayCache.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/ByteArrayCache.java
@@ -23,6 +23,8 @@ public class ByteArrayCache {
/**
* Default global byte array cache.
+ *
+ * <p>
* Note that this can't ever get garbage collected so don't add really large arrays!
*/
public static final ByteArrayCache DEFAULT = new ByteArrayCache();
@@ -33,8 +35,9 @@ public class ByteArrayCache {
* Add the specified byte array to this cache.
*
* @param contents The byte array to add to this cache.
- * @return Either the same byte array or a previously cached byte array depending on whether the byte array
- * already exists in the cache.
+ * @return
+ * Either the same byte array or a previously cached byte array depending on whether the byte array already
+ * exists in the cache.
*/
public byte[] cache(byte[] contents) {
if (contents == null)
@@ -48,8 +51,9 @@ public class ByteArrayCache {
* Add the specified input stream to this cache.
*
* @param contents The input stream whose contents are to be added to this cache.
- * @return Either the same byte array or a previously cached byte array depending on whether the byte array
- * already exists in the cache.
+ * @return
+ * Either the same byte array or a previously cached byte array depending on whether the byte array already
+ * exists in the cache.
* @throws IOException
*/
public byte[] cache(InputStream contents) throws IOException {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/internal/Cache.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/Cache.java b/juneau-core/src/main/java/org/apache/juneau/internal/Cache.java
index 2b31062..e811bf5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/Cache.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/Cache.java
@@ -16,6 +16,7 @@ import java.util.concurrent.*;
/**
* Simple in-memory cache of objects.
+ *
* <p>
* Essentially just a wrapper around a ConcurrentHashMap.
*
@@ -59,8 +60,9 @@ public class Cache<K,V> {
*
* @param key The key.
* @param value The value.
- * @return Either the value already in the cache if it already exists, or the same value passed in.
- * Always returns the same value if the cache is disabled.
+ * @return
+ * Either the value already in the cache if it already exists, or the same value passed in.
+ * Always returns the same value if the cache is disabled.
*/
public V put(K key, V value) {
if (nocache)
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/f400b0c0/juneau-core/src/main/java/org/apache/juneau/internal/ClassUtils.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/internal/ClassUtils.java b/juneau-core/src/main/java/org/apache/juneau/internal/ClassUtils.java
index 00b7994..ca39426 100644
--- a/juneau-core/src/main/java/org/apache/juneau/internal/ClassUtils.java
+++ b/juneau-core/src/main/java/org/apache/juneau/internal/ClassUtils.java
@@ -111,6 +111,7 @@ public final class ClassUtils {
/**
* Converts the string generated by {@link #getReadableClassName(Class)} back into a {@link Class}.
+ *
* <p>
* Generics are stripped from the string since they cannot be converted to a class.
*
@@ -174,6 +175,8 @@ public final class ClassUtils {
/**
* Returns the signature of the specified method.
+ *
+ * <p>
* For no-arg methods, the signature will be a simple string such as <js>"toString"</js>.
* For methods with one or more args, the arguments will be fully-qualified class names (e.g.
* <js>"append(java.util.StringBuilder,boolean)"</js>)
@@ -346,9 +349,11 @@ public final class ClassUtils {
/**
* Returns the specified annotation on the specified method.
+ *
* <p>
* Similar to {@link Method#getAnnotation(Class)}, but searches up the parent hierarchy for the annotation
* defined on parent classes and interfaces.
+ *
* <p>
* Normally, annotations defined on methods of parent classes and interfaces are not inherited by the child methods.
* This utility method gets around that limitation by searching the class hierarchy for the "same" method
@@ -364,18 +369,21 @@ public final class ClassUtils {
/**
* Returns the specified annotation on the specified method.
+ *
* <p>
* Similar to {@link Method#getAnnotation(Class)}, but searches up the parent hierarchy for the annotation defined
* on parent classes and interfaces.
+ *
* <p>
* Normally, annotations defined on methods of parent classes and interfaces are not inherited by the child methods.
* This utility method gets around that limitation by searching the class hierarchy for the "same" method
* (i.e. the same name and arguments).
*
* @param a The annotation to search for.
- * @param c The child class to start searching from.
- * Note that it can be a descendant class of the actual declaring class of the method passed in.
- * This allows you to find annotations on methods overridden by the method passed in.
+ * @param c
+ * The child class to start searching from.
+ * Note that it can be a descendant class of the actual declaring class of the method passed in.
+ * This allows you to find annotations on methods overridden by the method passed in.
* @param method The method to search.
* @return The annotation, or <jk>null</jk> if it wasn't found.
*/
@@ -407,6 +415,8 @@ public final class ClassUtils {
/**
* Locates the no-arg constructor for the specified class.
+ *
+ * <p>
* Constructor must match the visibility requirements specified by parameter 'v'.
* If class is abstract, always returns <jk>null</jk>.
* Note that this also returns the 1-arg constructor for non-static member classes.
@@ -519,14 +529,16 @@ public final class ClassUtils {
*
* @param c The class to look for the method.
* @param name The method name.
- * @param returnType The return type of the method.
- * Can be a super type of the actual return type.
- * For example, if the actual return type is <code>CharSequence</code>, then <code>Object</code> will match but
- * <code>String</code> will not.
- * @param parameterTypes The parameter types of the method.
- * Can be subtypes of the actual parameter types.
- * For example, if the parameter type is <code>CharSequence</code>, then <code>String</code> will match but
- * <code>Object</code> will not.
+ * @param returnType
+ * The return type of the method.
+ * Can be a super type of the actual return type.
+ * For example, if the actual return type is <code>CharSequence</code>, then <code>Object</code> will match but
+ * <code>String</code> will not.
+ * @param parameterTypes
+ * The parameter types of the method.
+ * Can be subtypes of the actual parameter types.
+ * For example, if the parameter type is <code>CharSequence</code>, then <code>String</code> will match but
+ * <code>Object</code> will not.
* @return The matched method, or <jk>null</jk> if no match was found.
*/
public static Method findPublicMethod(Class<?> c, String name, Class<?> returnType, Class<?>...parameterTypes) {
@@ -556,8 +568,9 @@ public final class ClassUtils {
* Finds a public constructor with the specified parameters without throwing an exception.
*
* @param c The class to search for a constructor.
- * @param parameterTypes The parameter types in the constructor.
- * Can be subtypes of the actual constructor argument types.
+ * @param parameterTypes
+ * The parameter types in the constructor.
+ * Can be subtypes of the actual constructor argument types.
* @return The matching constructor, or <jk>null</jk> if constructor could not be found.
*/
@SuppressWarnings("unchecked")
@@ -586,8 +599,9 @@ public final class ClassUtils {
*
* @param c The class we're trying to construct.
* @param args The arguments we want to pass into the constructor.
- * @return The constructor, or <jk>null</jk> if a public constructor could not be found that takes
- * in the specified arguments.
+ * @return
+ * The constructor, or <jk>null</jk> if a public constructor could not be found that takes in the specified
+ * arguments.
*/
public static <T> Constructor<T> findPublicConstructor(Class<T> c, Object...args) {
return findPublicConstructor(c, getClasses(args));
@@ -762,8 +776,9 @@ public final class ClassUtils {
* Creates an instance of the specified class without throwing exceptions.
*
* @param c The class to cast to.
- * @param c2 The class to instantiate.
- * Can also be an instance of the class.
+ * @param c2
+ * The class to instantiate.
+ * Can also be an instance of the class.
* @param args The arguments to pass to the constructor.
* @return The new class instance, or <jk>null</jk> if the class was <jk>null</jk> or is abstract or an interface.
* @throws RuntimeException if constructor could not be found or called.