http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java b/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java index 78b4d6d..d71ba6f 100644 --- a/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java +++ b/juneau-core/src/main/java/org/apache/juneau/annotation/Bean.java @@ -46,15 +46,19 @@ public @interface Bean { /** * An identifying name for this class. + * * <p> * The name is used to identify the class type during parsing when it cannot be inferred through reflection. * For example, if a bean property is of type <code>Object</code>, then the serializer will add the name to the - * output so that the class can be determined during parsing. + * output so that the class can be determined during parsing. * It is also used to specify element names in XML. + * * <p> * The name is used in combination with the bean dictionary defined through {@link BeanProperty#beanDictionary()} or - * {@link BeanContext#BEAN_beanDictionary}. Together, they make up a simple name/value mapping of names to classes. - * Names do not need to be universally unique. However, they must be unique within a dictionary. + * {@link BeanContext#BEAN_beanDictionary}. + * Together, they make up a simple name/value mapping of names to classes. + * Names do not need to be universally unique. + * However, they must be unique within a dictionary. * * <h5 class='section'>Example:</h5> * <p class='bcode'> @@ -71,9 +75,9 @@ public @interface Bean { * <ja>@Bean</ja>(typeName=<js>"baz"</js>) * <jk>public class</jk> Baz {} * </p> + * * <p> * When serialized as XML, the bean is rendered as: - * </p> * <p class='bcode'> * <xt><foo></xt> * <xt><x></xt> @@ -82,9 +86,9 @@ public @interface Bean { * <xt></x></xt> * <xt></foo></xt> * </p> + * * <p> * When serialized as JSON, <js>'n'</js> attributes would be added when needed to infer the type during parsing: - * </p> * <p class='bcode'> * { * x: [ @@ -99,9 +103,11 @@ public @interface Bean { /** * The property name to use for representing the type name. + * * <p> * This can be used to override the name used for the <js>"_type"</js> property designated above. * Typically, you'll define this on an interface class so that it can apply to all subclasses. + * * <p class='bcode'> * <ja>@Bean</ja>(typePropertyName=<js>"mytype"</js>, beanDictionary={MyClass1.<jk>class</jk>,MyClass2.<jk>class</jk>}) * <jk>public interface</jk> MyInterface {...} @@ -117,6 +123,7 @@ public @interface Bean { * <jc>// Produces "[{mytype:'C1',...},{mytype:'C2',...}]"</jc> * String json = JsonSerializer.<jsf>DEFAULT_LAX</jsf>.serialize(x); * </p> + * * <p> * This is similar in concept to the {@link BeanContext#BEAN_beanTypePropertyName} setting except this annotation * applies only to the annotated class and subclasses whereas the bean context property applies globally on @@ -135,9 +142,11 @@ public @interface Bean { /** * The set and order of names of properties associated with a bean class. + * * <p> * The order specified is the same order that the entries will be returned by the {@link BeanMap#entrySet()} and * related methods. + * * <p> * This annotation is an alternative to using the {@link BeanFilter} class with an implemented * {@link BeanFilter#getProperties()} method. @@ -155,24 +164,27 @@ public @interface Bean { /** * Sort bean properties in alphabetical order. + * * <p> * When <jk>true</jk>, all bean properties will be serialized and access in alphabetical order. - * Otherwise, the natural order of the bean properties is used which is dependent on the - * JVM vendor. + * Otherwise, the natural order of the bean properties is used which is dependent on the JVM vendor. * On IBM JVMs, the bean properties are ordered based on their ordering in the Java file. * On Oracle JVMs, the bean properties are not ordered (which follows the official JVM specs). + * * <p> * This property is disabled by default so that IBM JVM users don't have to use {@link Bean @Bean} annotations * to force bean properties to be in a particular order and can just alter the order of the fields/methods * in the Java file. + * * <p> - * This annotation is equivalent to using the {@link BeanContext#BEAN_sortProperties} property, but - * applied to individual classes instead of globally at the serializer or parser level. + * This annotation is equivalent to using the {@link BeanContext#BEAN_sortProperties} property, but applied to + * individual classes instead of globally at the serializer or parser level. */ boolean sort() default false; /** * Specifies a list of properties that should be excluded from {@link BeanMap#entrySet()}. + * * <p> * This annotation is an alternative to using the {@link BeanFilter} class with an implemented * {@link BeanFilter#getExcludeProperties()} method. @@ -190,10 +202,12 @@ public @interface Bean { /** * Associates a {@link PropertyNamer} with this bean to tailor the names of the bean properties. + * * <p> * Property namers are used to transform bean property names from standard form to some other form. * For example, the {@link PropertyNamerDLC} will convert property names to dashed-lowercase, and these will be used * as attribute names in JSON, and element names in XML. + * * <p> * This annotation is an alternative to using the {@link BeanFilter} class with an implemented * {@link BeanFilter#getPropertyNamer()} method. @@ -211,9 +225,11 @@ public @interface Bean { /** * Identifies a class to be used as the interface class for this and all subclasses. + * * <p> * When specified, only the list of properties defined on the interface class will be used during serialization. * Additional properties on subclasses will be ignored. + * * <p class='bcode'> * <jc>// Parent class</jc> * <ja>@Bean</ja>(interfaceClass=A.<jk>class</jk>) @@ -231,9 +247,11 @@ public @interface Bean { * String r = s.serialize(a1); * <jsm>assertEquals</jsm>(<js>"{f0:'f0'}"</js>, r); // Note f1 is not serialized. * </p> + * * <p> * Note that this annotation can be used on the parent class so that it filters to all child classes, - * or can be set individually on the child classes. + * or can be set individually on the child classes. + * * <p> * This annotation is an alternative to using the {@link BeanFilter} class with an implemented * {@link BeanFilter#getInterfaceClass()} method. @@ -242,9 +260,11 @@ public @interface Bean { /** * Identifies a stop class for the annotated class. + * * <p> * Identical in purpose to the stop class specified by {@link Introspector#getBeanInfo(Class, Class)}. * Any properties in the stop class or in its base classes will be ignored during analysis. + * * <p> * For example, in the following class hierarchy, instances of <code>C3</code> will include property <code>p3</code>, * but not <code>p1</code> or <code>p2</code>. @@ -267,10 +287,12 @@ public @interface Bean { /** - * The list of classes that make up the bean dictionary for all properties of this bean - * or for subclasses of this bean. + * The list of classes that make up the bean dictionary for all properties of this bean or for subclasses of this + * bean. + * * <p> * This is a shorthand for setting the {@link BeanProperty#beanDictionary()} on all properties of the bean. + * * <p> * This list can consist of the following class types: * <ul>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java index fb6a133..e4bf51c 100644 --- a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java +++ b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanConstructor.java @@ -21,11 +21,13 @@ import org.apache.juneau.*; /** * Maps constructor arguments to property names on beans with read-only properties. + * * <p> * This annotation can be used in the case of beans with properties whose values can only be set by passing them in * through a constructor on the class. * <br>Since method parameter names are lost during compilation, this annotation essentially redefines them so that they * are available at runtime. + * * <p> * The definition of a read-only bean is a bean with properties with only getters, like shown below... * <p class='bcode'> @@ -55,17 +57,21 @@ import org.apache.juneau.*; * String name = p.getName(); <jc>// "John Smith"</jc> * <jk>int</jk> age = p.getAge(); <jc>// 45</jc> * </p> + * * <p> * This annotation can only be applied to constructors and can only be applied to one constructor per class. + * * <p> * When present, bean instantiation is delayed until the call to {@link BeanMap#getBean()}. * Until then, bean property values are stored in a local cache until <code>getBean()</code> is called. - * Because of this additional caching step, parsing into read-only beans tends to be slower and use - * more memory than parsing into beans with writable properties. + * Because of this additional caching step, parsing into read-only beans tends to be slower and use more memory than + * parsing into beans with writable properties. + * * <p> * Attempting to call {@link BeanMap#put(String,Object)} on a read-only property after calling {@link BeanMap#getBean()} * will result in a {@link BeanRuntimeException} being thrown. * Multiple calls to {@link BeanMap#getBean()} will return the same bean instance. + * * <p> * Beans can be defined with a combination of read-only and read-write properties. */ @@ -77,6 +83,7 @@ public @interface BeanConstructor { /** * The names of the properties of the constructor arguments. + * * <p> * The number of properties listed must match the number of arguments in the constructor. */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java index c7c1d30..efaa145 100644 --- a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java +++ b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanIgnore.java @@ -19,12 +19,15 @@ import java.lang.annotation.*; /** * Ignore classes, fields, and methods from being interpreted as bean or bean components. + * * <p> * Applied to classes that may look like beans, but you want to be treated as non-beans. * For example, if you want to force a bean to be converted to a string using the <code>toString()</code> method, use * this annotation on the class. + * * <p> * Applies to fields that should not be interpreted as bean property fields. + * * <p> * Applies to getters or setters that should not be interpreted as bean property getters or setters. */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/BeanParam.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanParam.java b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanParam.java index 65609bd..47137fe 100644 --- a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanParam.java +++ b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanParam.java @@ -14,7 +14,7 @@ package org.apache.juneau.annotation; /** - * TODO + * Future support for defining bean properties on constructor args. */ public @interface BeanParam { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java index 46a8d19..764b5c2 100644 --- a/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java +++ b/juneau-core/src/main/java/org/apache/juneau/annotation/BeanProperty.java @@ -60,21 +60,24 @@ public @interface BeanProperty { /** * Identifies the name of the property. + * * <p> - * Normally, this is automatically inferred from the field name or getter method name - * of the property. However, this property can be used to assign a different - * property name from the automatically inferred value. + * Normally, this is automatically inferred from the field name or getter method name of the property. + * However, this property can be used to assign a different property name from the automatically inferred value. + * * <p> * If the {@link BeanContext#BEAN_beanFieldVisibility} setting on the bean context excludes this field (e.g. the * visibility is set to PUBLIC, but the field is PROTECTED), this annotation can be used to force the field to be * identified as a property. * * <h6 class='topic'>Dynamic beans</h6> + * <p> * The bean property named <js>"*"</js> is the designated "dynamic property" which allows for "extra" bean * properties not otherwise defined. * This is similar in concept to the Jackson <ja>@JsonGetterAll</ja> and <ja>@JsonSetterAll</ja> annotations. * The primary purpose is for backwards compatibility in parsing newer streams with addition information into older * beans. + * * <p> * The following examples show how to define dynamic bean properties. * <p class='bcode'> @@ -113,9 +116,10 @@ public @interface BeanProperty { * } * } * </p> - * <p> - * Similar rules apply for value types and swaps. The property values optionally can be any serializable type or - * use swaps. + * + *<p> + * Similar rules apply for value types and swaps. + * The property values optionally can be any serializable type or use swaps. * <p class='bcode'> * <jc>// A serializable type other than Object.</jc> * <jk>public class</jk> BeanWithDynaFieldWithListValues { @@ -135,7 +139,7 @@ public @interface BeanProperty { * } * } * </p> - * <p> + * * <ul class='doctree'> * <li class='info'> * Note that if you're not interested in these additional properties, you can also use the @@ -147,9 +151,10 @@ public @interface BeanProperty { /** * A synonym for {@link #name()}. + * * <p> * The following annotations are equivalent: - * <p> + * * <p class='bcode'> * <ja>@BeanProperty</ja>(name=<js>"foo"</js>) * @@ -160,11 +165,13 @@ public @interface BeanProperty { /** * Identifies a specialized class type for the property. + * * <p> * Normally this can be inferred through reflection of the field type or getter return type. * However, you'll want to specify this value if you're parsing beans where the bean property class is an interface * or abstract class to identify the bean type to instantiate. * Otherwise, you may cause an {@link InstantiationException} when trying to set these fields. + * * <p> * This property must denote a concrete bean class with a no-arg constructor. * @@ -199,8 +206,10 @@ public @interface BeanProperty { /** * Associates a {@link PojoSwap} or {@link SurrogateSwap} with this bean property that will swap the value object * with another object during serialization and parsing. + * * <p> * This annotation supersedes any swaps associated with the bean property type class itself. + * * <p> * Typically used for rendering {@link Date Dates} and {@link Calendar Calendars} as a particular string format. * @@ -218,6 +227,7 @@ public @interface BeanProperty { /** * Used to limit which child properties are rendered by the serializers. + * * <p> * Can be used on any of the following bean property types: * <ul class='spaced-list'> @@ -249,10 +259,12 @@ public @interface BeanProperty { /** * The list of classes that make up the bean dictionary for this bean property. + * * <p> * The dictionary is a name/class mapping used to find class types during parsing when they cannot be inferred * through reflection. * The names are defined through the {@link Bean#typeName()} annotation defined on the bean class. + * * <p> * This list can consist of the following class types: * <ul> @@ -267,8 +279,10 @@ public @interface BeanProperty { /** * Specifies a String format for converting the bean property value to a formatted string. + * * <p> * Note that this is usually a one-way conversion during serialization. + * * <p> * During parsing, we will attempt to convert the value to the original form by using the * {@link BeanSession#convertToType(Object, Class)} but there is no guarantee that this will succeed. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/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 32adb2d..e4051ef 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 @@ -25,6 +25,7 @@ import org.apache.juneau.parser.*; * <h5 class='section'>Description:</h5> * <p> * Provides a way to define the contents of {@link Parser#getMediaTypes()} through an annotation. + * * <p> * The {@link Parser#getMediaTypes()} default implementation gathers the media types by looking for this annotation. * It should be noted that this annotation is optional and that the {@link Parser#getMediaTypes()} method can be @@ -37,9 +38,11 @@ import org.apache.juneau.parser.*; * <ja>@Consumes</ja>(<js>"application/json,text/json"</js>) * <jk>public class</jk> JsonParser <jk>extends</jk> ReaderParser {...} * </p> + * * <p> * The media types can also be <code>media-range</code> values per - * <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1";>RFC2616/14.1</a>. + * <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1";>RFC2616/14.1</a>. + * * <p class='bcode'> * <jc>// Consumes any text</jc> * <ja>@Consumes</ja>(<js>"text\/*"</js>) @@ -58,6 +61,7 @@ public @interface Consumes { /** * A comma-delimited list of media types that the parser can handle. + * * <p> * Can contain meta-characters per the <code>media-type</code> specification of * <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1";>RFC2616/14.1</a> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java b/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java index bce8d94..ac6d3b2 100644 --- a/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java +++ b/juneau-core/src/main/java/org/apache/juneau/annotation/NameProperty.java @@ -20,16 +20,18 @@ import java.lang.annotation.*; import org.apache.juneau.ini.*; /** - * Identifies a setter as a method for setting the name of a POJO as it's known by - * its parent object. + * Identifies a setter as a method for setting the name of a POJO as it's known by its parent object. + * * <p> - * For example, the {@link Section} class must know the name it's known by it's parent - * {@link ConfigFileImpl} class, so parsers will call this method with the section name + * For example, the {@link Section} class must know the name it's known by it's parent {@link ConfigFileImpl} class, + * so parsers will call this method with the section name * using the {@link Section#setName(String)} method. * <p> * A commonly-used case is when you're parsing a JSON map containing beans where one of the bean properties is the key * used in the map. - * <br>For example: + * + * <p> + * For example: * <p class='bcode'> * { * id1: {name: <js>'John Smith'</js>, sex:<js>'M'</js>}, http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java b/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java index 6df9bb9..a6f24af 100644 --- a/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java +++ b/juneau-core/src/main/java/org/apache/juneau/annotation/ParentProperty.java @@ -21,10 +21,12 @@ import org.apache.juneau.ini.*; /** * Identifies a setter as a method for adding a parent reference to a child object. + * * <p> * Used by the parsers to add references to parent objects in child objects. * For example, the {@link Section} class cannot exist outside the scope of a parent {@link ConfigFileImpl} class, so * parsers will add a reference to the config file using the {@link Section#setParent(ConfigFileImpl)} method. + * * <p> * A commonly-used case is when you're parsing beans, and a child bean has a reference to a parent bean. * <p class='bcode'> @@ -38,7 +40,6 @@ import org.apache.juneau.ini.*; * <jk>public char</jk> <jf>sex</jf>; * } * </p> - * <p> * * <h5 class='section'>Notes:</h5> * <ul> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/Pojo.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/Pojo.java b/juneau-core/src/main/java/org/apache/juneau/annotation/Pojo.java index 6e41c31..0823e6d 100644 --- a/juneau-core/src/main/java/org/apache/juneau/annotation/Pojo.java +++ b/juneau-core/src/main/java/org/apache/juneau/annotation/Pojo.java @@ -72,6 +72,7 @@ public @interface Pojo { * <jsm>assertEquals</jsm>(<js>"bar"</js>, b.<jf>f1</jf>); * } * </p> + * * <p> * Note that using this annotation is functionally equivalent to adding swaps to the serializers and parsers: * <p class='bcode'> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/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 aa29dc0..cf705e7 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 @@ -25,6 +25,7 @@ import org.apache.juneau.serializer.*; * <h5 class='section'>Description:</h5> * <p> * Provides a way to define the contents of {@link Serializer#getMediaTypes()} through an annotation. + * * <p> * The {@link Serializer#getMediaTypes()} default implementation gathers the media types by looking for this annotation. * <br>It should be noted that this annotation is optional and that the {@link Serializer#getMediaTypes()} method can @@ -37,6 +38,7 @@ import org.apache.juneau.serializer.*; * <ja>@Produces</ja>(<js>"application/json,text/json"</js>) * <jk>public class</jk> JsonSerializer <jk>extends</jk> WriterSerializer {...} * </p> + * * <p> * The media types can also be <code>media-range</code> values per * <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1";>RFC2616/14.1</a>. @@ -61,6 +63,7 @@ public @interface Produces { /** * A comma-delimited list of the media types that the serializer can handle. + * * <p> * Can contain meta-characters per the <code>media-type</code> specification of * <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1";>RFC2616/14.1</a> @@ -71,6 +74,7 @@ public @interface Produces { /** * The content type that this serializer produces. + * * <p> * Can be used to override the <code>Content-Type</code> response type if the media types are * <code>media-ranges</code> with meta-characters, or the <code>Content-Type</code> differs from the media type for some reason. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/ThreadSafe.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/ThreadSafe.java b/juneau-core/src/main/java/org/apache/juneau/annotation/ThreadSafe.java index b992753..fdda089 100644 --- a/juneau-core/src/main/java/org/apache/juneau/annotation/ThreadSafe.java +++ b/juneau-core/src/main/java/org/apache/juneau/annotation/ThreadSafe.java @@ -18,6 +18,7 @@ import java.lang.annotation.*; /** * Identifies a class as being thread-safe. + * * <p> * Used for documentation purposes only. */ http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/annotation/URI.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/annotation/URI.java b/juneau-core/src/main/java/org/apache/juneau/annotation/URI.java index 24dbec9..192664b 100644 --- a/juneau-core/src/main/java/org/apache/juneau/annotation/URI.java +++ b/juneau-core/src/main/java/org/apache/juneau/annotation/URI.java @@ -23,20 +23,25 @@ import org.apache.juneau.serializer.*; /** * Used to identify a class or bean property as a URI. + * * <p> * By default, instances of {@link URL} and {@link URI} are considered URIs during serialization, and are handled * differently depending on the serializer (e.g. <code>HtmlSerializer</code> creates a hyperlink, * <code>RdfXmlSerializer</code> creates an <code>rdf:resource</code> object, etc...). + * * <p> * This annotation allows you to identify other classes that return URIs via <code>toString()</code> as URI objects. + * * <p> * URIs are automatically resolved to absolute or root-relative form based on the serializer * {@link SerializerContext#SERIALIZER_uriResolution} and {@link SerializerContext#SERIALIZER_uriRelativity} * configuration settings, and the URI context defined by the {@link UriContext} that's part of the serializer * session. + * * <p> * Refer to the {@link UriResolver} class for information about the types of URIs that can be resolved during * serialization. + * * <p> * This annotation can be applied to classes, interfaces, or bean property methods for fields. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java b/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java index 926c263..93c5f57 100644 --- a/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java +++ b/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserContext.java @@ -17,9 +17,11 @@ import org.apache.juneau.parser.*; /** * Configurable properties on the {@link CsvParser} class. + * * <p> * Context properties are set by calling {@link PropertyStore#setProperty(String, Object)} on the property store * passed into the constructor. + * * <p> * See {@link PropertyStore} for more information about context properties. * @@ -39,6 +41,7 @@ public final class CsvParserContext extends ParserContext { /** * Constructor. + * * <p> * Typically only called from {@link PropertyStore#getContext(Class)}. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserSession.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserSession.java b/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserSession.java index 548cbd2..97a24aa 100644 --- a/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserSession.java +++ b/juneau-core/src/main/java/org/apache/juneau/csv/CsvParserSession.java @@ -22,6 +22,7 @@ import org.apache.juneau.parser.*; /** * Session object that lives for the duration of a single use of {@link CsvParser}. + * * <p> * This class is NOT thread safe. It is meant to be discarded after one-time use. */ @@ -32,24 +33,29 @@ public final class CsvParserSession 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. - * @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> - * @param op The override properties. - * These override any context properties defined in the context. + * @param ctx + * The context creating this session 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> + * @param op + * The override properties. + * 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. - * @param timeZone The session timezone. - * If <jk>null</jk>, then the timezone defined on the context is used. + * @param locale + * The session locale. + * 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. * @param mediaType The session media type (e.g. <js>"application/json"</js>). */ public CsvParserSession(CsvParserContext ctx, ObjectMap op, Object input, Method javaMethod, Object outer, Locale locale, TimeZone timeZone, MediaType mediaType) { @@ -72,6 +78,7 @@ public final class CsvParserSession extends ParserSession { /** * Returns <jk>true</jk> if the specified character is whitespace. + * * <p> * The definition of whitespace is different for strict vs lax mode. * Strict mode only interprets 0x20 (space), 0x09 (tab), 0x0A (line feed) and 0x0D (carriage return) as whitespace. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java index fa84e3e..3c8c77b 100644 --- a/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java +++ b/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerContext.java @@ -17,9 +17,11 @@ import org.apache.juneau.serializer.*; /** * Configurable properties on the {@link CsvSerializer} class. + * * <p> * Context properties are set by calling {@link PropertyStore#setProperty(String, Object)} on the property store * passed into the constructor. + * * <p> * See {@link PropertyStore} for more information about context properties. * @@ -39,6 +41,7 @@ public final class CsvSerializerContext extends SerializerContext { /** * Constructor. + * * <p> * Typically only called from {@link PropertyStore#getContext(Class)}. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java b/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java index cde39cc..c9fd758 100644 --- a/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java +++ b/juneau-core/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java @@ -21,6 +21,7 @@ import org.apache.juneau.serializer.*; /** * Session object that lives for the duration of a single use of {@link CsvSerializer}. + * * <p> * This class is NOT thread safe. It is meant to be discarded after one-time use. */ @@ -29,16 +30,20 @@ public final class CsvSerializerSession 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. + * @param ctx + * The context creating this session object. + * The context contains all the configuration settings for this object. * @param output The output object. - * @param op The override properties. - * These override any context properties defined in the context. + * @param op + * The override properties. + * These override any context properties defined in the context. * @param javaMethod The java method that called this serializer, 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. - * @param timeZone The session timezone. - * If <jk>null</jk>, then the timezone defined on the context is used. + * @param locale + * The session locale. + * 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. * @param mediaType The session media type (e.g. <js>"application/json"</js>). * @param uriContext The URI context. * Identifies the current request URI used for resolution of URIs to absolute or root-relative form. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/Link.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/Link.java b/juneau-core/src/main/java/org/apache/juneau/dto/Link.java index 96d025f..6677dc0 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/Link.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/Link.java @@ -23,13 +23,16 @@ import org.apache.juneau.utils.*; /** * Simple bean that implements a hyperlink for the HTML serializer. + * * <p> * The name and url properties correspond to the following parts of a hyperlink in an HTML document... * <p class='bcode'> * <xt><a</xt> <xa>href</xa>=<xs>'href'</xs><xt>></xt>name<xt></a></xt> + * </p> + * * <p> * When encountered by the {@link HtmlSerializer} class, this object gets converted to a hyperlink. - * <br>All other serializers simply convert it to a simple bean. + * All other serializers simply convert it to a simple bean. */ @HtmlLink(nameProperty = "name", hrefProperty = "href") public class Link implements Comparable<Link> { @@ -57,6 +60,8 @@ public class Link implements Comparable<Link> { /** * Bean property getter: <property>name</property>. + * + * <p> * Corresponds to the text inside of the <xt><A></xt> element. * * @return The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set. @@ -78,6 +83,8 @@ public class Link implements Comparable<Link> { /** * Bean property getter: <property>href</property>. + * + * <p> * Corresponds to the value of the <xa>href</xa> attribute of the <xt><A></xt> element. * * @return The value of the <property>href</property> property on this bean, or <jk>null</jk> if it is not set. @@ -99,6 +106,8 @@ public class Link implements Comparable<Link> { /** * Bean property setter: <property>href</property>. + * + * <p> * Same as {@link #setHref(String)} except allows for {@link MessageFormat} style arguments. * * @param href The new href. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/ResultSetList.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/ResultSetList.java b/juneau-core/src/main/java/org/apache/juneau/dto/ResultSetList.java index 4f99c0d..8fa21ff 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/ResultSetList.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/ResultSetList.java @@ -21,7 +21,8 @@ import org.apache.juneau.internal.*; /** * Transforms an SQL {@link ResultSet ResultSet} into a list of maps. - * <p> + * < + * p> * Loads the entire result set into an in-memory data structure, and then closes the result set object. */ public final class ResultSetList extends LinkedList<Map<String,Object>> { @@ -75,6 +76,8 @@ public final class ResultSetList extends LinkedList<Map<String,Object>> { /** * Reads the specified column from the current row in the result set. + * + * <p> * Subclasses can override this method to handle specific data types in special ways. * * @param rs The result set to read from. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java index 0850725..87c80e5 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/AtomBuilder.java @@ -19,6 +19,7 @@ import org.apache.juneau.*; /** * Various useful static methods for creating ATOM elements. + * * <p> * Typically, you'll want to do a static import on this class and then call the methods like so... * <p class='bcode'> @@ -146,9 +147,11 @@ public class AtomBuilder { /** * Creates an {@link Icon} element with the specified {@link Icon#uri(Object)} attribute. + * * <p> * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}. * Strings must be valid URIs. + * * <p> * URIs defined by {@link UriResolver} can be used for values. * @@ -184,9 +187,11 @@ public class AtomBuilder { /** * Creates a {@link Logo} element with the specified {@link Logo#uri(Object)} attribute. + * * <p> * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}. * Strings must be valid URIs. + * * <p> * URIs defined by {@link UriResolver} can be used for values. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java index 2922276..4f0e583 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Category.java @@ -78,7 +78,6 @@ public class Category extends Common { //-------------------------------------------------------------------------------- /** - * * @return The category term. */ @Xml(format=ATTR) @@ -110,9 +109,11 @@ public class Category extends Common { /** * Sets the category scheme. + * * <p> * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}. * Strings must be valid URIs. + * * <p> * URIs defined by {@link UriResolver} can be used for values. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java index 86c28aa..544b8f2 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Common.java @@ -71,9 +71,11 @@ public abstract class Common { /** * Sets the URI base of this object. + * * <p> * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}. * Strings must be valid URIs. + * * <p> * URIs defined by {@link UriResolver} can be used for values. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java index 5381c40..e90c674 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Content.java @@ -116,9 +116,11 @@ public class Content extends Text { /** * Sets the source URI. + * * <p> * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}. * Strings must be valid URIs. + * * <p> * URIs defined by {@link UriResolver} can be used for values. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java index 0e00ebf..4c5ca0b 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Feed.java @@ -21,6 +21,7 @@ import org.apache.juneau.xml.annotation.*; /** * Top-level ATOM feed object. + * * <p> * Represents an <code>atomFeed</code> construct in the RFC4287 specification. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java index 983d299..2abcc0d 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Generator.java @@ -88,9 +88,11 @@ public class Generator extends Common { /** * Sets the URI of this generator statement. + * * <p> * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}. * Strings must be valid URIs. + * * <p> * URIs defined by {@link UriResolver} can be used for values. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java index e146669..e16ae23 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Icon.java @@ -57,9 +57,11 @@ public class Icon extends Common { /** * Normal constructor. + * * <p> * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}. * Strings must be valid URIs. + * * <p> * URIs defined by {@link UriResolver} can be used for values. * @@ -89,9 +91,11 @@ public class Icon extends Common { /** * Sets the URI of this icon. + * * <p> * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}. * Strings must be valid URIs. + * * <p> * URIs defined by {@link UriResolver} can be used for values. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java index c3d7e4c..695f1c5 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Link.java @@ -137,6 +137,7 @@ public class Link extends Common { /** * Sets the content type of the target of this link. + * * <p> * Must be one of the following: * <ul> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java index ac1fdc0..97e045e 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Logo.java @@ -57,9 +57,11 @@ public class Logo extends Common { /** * Normal constructor. + * * <p> * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}. * <br>Strings must be valid URIs. + * * <p> * URIs defined by {@link UriResolver} can be used for values. * @@ -89,9 +91,11 @@ public class Logo extends Common { /** * Sets the URI of the logo. + * * <p> * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}. * <br>Strings must be valid URIs. + * * <p> * URIs defined by {@link UriResolver} can be used for values. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java index 9a30649..f557a97 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Person.java @@ -106,9 +106,11 @@ public class Person extends Common { /** * Sets the URI of the person. + * * <p> * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}. * Strings must be valid URIs. + * * <p> * URIs defined by {@link UriResolver} can be used for values. * http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java index fc1dd9f..572e08a 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/atom/Text.java @@ -91,6 +91,7 @@ public class Text extends Common { /** * Sets the content type of this content. + * * <p> * Must be one of the following: * <ul> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/cognos/Column.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/cognos/Column.java b/juneau-core/src/main/java/org/apache/juneau/dto/cognos/Column.java index 5862668..a86ba4d 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/cognos/Column.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/cognos/Column.java @@ -18,6 +18,7 @@ import org.apache.juneau.xml.annotation.*; /** * Represents a meta-data column in a Cognos dataset. + * * <p> * When serialized to XML, creates the following construct: * <p class='bcode'> @@ -60,12 +61,13 @@ public class Column { /** * Associates a POJO swap with this column. + * * <p> * Typically used to define columns that don't exist on the underlying beans being serialized. + * * <p> - * For example, the <code>AddressBookResource</code> sample defined the following POJO swap - * to define an additional <js>"numAddresses"</js> column even though no such property exists - * on the serialized beans. + * For example, the <code>AddressBookResource</code> sample defined the following POJO swap to define an additional + * <js>"numAddresses"</js> column even though no such property exists on the serialized beans. * <p class='bcode'> * Column c = <jk>new</jk> Column(<js>"numAddresses"</js>, <js>"xs:int"</js>) * .addPojoSwaps( http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/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 739001b..dd3f112 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 @@ -20,6 +20,7 @@ import org.apache.juneau.xml.annotation.*; /** * Represents a Cognos dataset. + * * <p> * When serialized to XML, creates the following construct (example pulled from <code>AddressBookResource</code>): * <p class='bcode'> @@ -45,6 +46,7 @@ import org.apache.juneau.xml.annotation.*; * <xt></c:data></xt> * <xt></c:dataset></xt> * </p> + * * <p> * Only 2-dimensional POJOs (arrays or collections of maps or beans) can be serialized to Cognos. * @@ -88,8 +90,9 @@ public class DataSet { * Constructor. * * @param columns The meta-data that represents the columns in the dataset. - * @param o The POJO being serialized to Cognos. - * Must be an array/collection of beans/maps. + * @param o + * The POJO being serialized to Cognos. + * Must be an array/collection of beans/maps. * @param session The bean session used to convert POJOs to strings. * @throws Exception An error occurred trying to serialize the POJO. */ @@ -124,6 +127,7 @@ public class DataSet { /** * Represents a row of data. + * * <p> * When serialized to XML, creates the following construct (example pulled from <code>AddressBookResource</code>): * <p class='bcode'> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java index 843dfb6..242d7b8 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/A.java @@ -20,8 +20,8 @@ import org.apache.juneau.*; import org.apache.juneau.annotation.*; /** - * DTO for an HTML <a class="doclink" - * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-a-element";><a></a> element. + * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-a-element";><a></a> + * element. * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> @@ -40,9 +40,13 @@ public class A extends HtmlElementMixed { /** * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-download";>download</a> attribute. + * + * <p> * Whether to download the resource instead of navigating to it, and its file name if so. - * @param download The new value for this attribute. - * Typically a {@link Boolean} or {@link String}. + * + * @param download + * The new value for this attribute. + * Typically a {@link Boolean} or {@link String}. * @return This object (for method chaining). */ public final A download(Object download) { @@ -52,15 +56,20 @@ public class A extends HtmlElementMixed { /** * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-href";>href</a> attribute. + * + * <p> * Address of the hyperlink. + * * <p> * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}. * Strings must be valid URIs. + * * <p> * URIs defined by {@link UriResolver} can be used for values. * - * @param href The new value for this attribute. - * Typically a {@link URL} or {@link String}. + * @param href + * The new value for this attribute. + * Typically a {@link URL} or {@link String}. * @return This object (for method chaining). */ public final A href(Object href) { @@ -70,6 +79,8 @@ public class A extends HtmlElementMixed { /** * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-hreflang";>hreflang</a> attribute. + * + * <p> * Language of the linked resource. * * @param hreflang The new value for this attribute. @@ -82,6 +93,8 @@ public class A extends HtmlElementMixed { /** * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-rel";>rel</a> attribute. + * + * <p> * Relationship between the document containing the hyperlink and the destination resource. * * @param rel The new value for this attribute. @@ -94,6 +107,8 @@ public class A extends HtmlElementMixed { /** * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-target";>target</a> attribute. + * + * <p> * Default browsing context for hyperlink navigation and form submission. * * @param target The new value for this attribute. @@ -106,6 +121,8 @@ public class A extends HtmlElementMixed { /** * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-type";>type</a> attribute. + * + * <p> * Hint for the type of the referenced resource. * * @param type The new value for this attribute. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java index 510df45..0e2c075 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Abbr.java @@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5; import org.apache.juneau.annotation.*; /** - * DTO for an HTML <a class="doclink" - * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-abbr-element";><abbr></a> element. + * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-abbr-element";><abbr></a> + * element. * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java index 91856d3..cd60484 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Address.java @@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5; import org.apache.juneau.annotation.*; /** - * DTO for an HTML <a class="doclink" - * href="https://www.w3.org/TR/html5/sections.html#the-address-element";><address></a> element. + * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-address-element";><address></a> + * element. * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java index 7b69b4e..97a4463 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Area.java @@ -19,8 +19,8 @@ import org.apache.juneau.*; import org.apache.juneau.annotation.*; /** - * DTO for an HTML <a class="doclink" - * href="https://www.w3.org/TR/html5/embedded-content-0.html#the-area-element";><area></a> element. + * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#the-area-element";><area></a> + * element. * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> @@ -39,6 +39,8 @@ public class Area extends HtmlElementVoid { /** * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-area-alt";>alt</a> attribute. + * + * <p> * Replacement text for use when images are not available. * * @param alt The new value for this attribute. @@ -52,6 +54,8 @@ public class Area extends HtmlElementVoid { /** * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-area-coords";>coords</a> * attribute. + * + * <p> * Coordinates for the shape to be created in an image map. * * @param coords The new value for this attribute. @@ -64,10 +68,13 @@ public class Area extends HtmlElementVoid { /** * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-download";>download</a> attribute. + * + * <p> * Whether to download the resource instead of navigating to it, and its file name if so. * - * @param download The new value for this attribute. - * Typically a {@link Boolean} or {@link String}. + * @param download + * The new value for this attribute. + * Typically a {@link Boolean} or {@link String}. * @return This object (for method chaining). */ public final Area download(Object download) { @@ -77,15 +84,20 @@ public class Area extends HtmlElementVoid { /** * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-href";>href</a> attribute. + * + * <p> * Address of the hyperlink. + * * <p> * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}. * Strings must be valid URIs. + * * <p> * URIs defined by {@link UriResolver} can be used for values. * - * @param href The new value for this attribute. - * Typically a {@link URL} or {@link String}. + * @param href + * The new value for this attribute. + * Typically a {@link URL} or {@link String}. * @return This object (for method chaining). */ public final Area href(Object href) { @@ -95,6 +107,8 @@ public class Area extends HtmlElementVoid { /** * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-hreflang";>hreflang</a> attribute. + * + * <p> * Language of the linked resource. * * @param hreflang The new value for this attribute. @@ -107,6 +121,8 @@ public class Area extends HtmlElementVoid { /** * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-rel";>rel</a> attribute. + * + * <p> * Relationship between the document containing the hyperlink and the destination resource. * * @param rel The new value for this attribute. @@ -119,6 +135,8 @@ public class Area extends HtmlElementVoid { /** * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-area-shape";>shape</a> attribute. + * + * <p> * The kind of shape to be created in an image map. * * @param shape The new value for this attribute. @@ -131,6 +149,8 @@ public class Area extends HtmlElementVoid { /** * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-target";>target</a> attribute. + * + * <p> * Browsing context for hyperlink navigation. * * @param target The new value for this attribute. @@ -143,6 +163,8 @@ public class Area extends HtmlElementVoid { /** * <a class="doclink" href="https://www.w3.org/TR/html5/links.html#attr-hyperlink-type";>type</a> attribute. + * + * <p> * Hint for the type of the referenced resource. * * @param type The new value for this attribute. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java index 2953d0d..519e4b0 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Article.java @@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5; import org.apache.juneau.annotation.*; /** - * DTO for an HTML <a class="doclink" - * href="https://www.w3.org/TR/html5/sections.html#the-article-element";><article></a> element. + * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-article-element";><article></a> + * element. * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java index c14e239..ca5cf08 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Aside.java @@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5; import org.apache.juneau.annotation.*; /** - * DTO for an HTML <a class="doclink" - * href="https://www.w3.org/TR/html5/sections.html#the-aside-element";><aside></a> element. + * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-aside-element";><aside></a> + * element. * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java index 7ff0379..1acd391 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Audio.java @@ -19,8 +19,8 @@ import org.apache.juneau.*; import org.apache.juneau.annotation.*; /** - * DTO for an HTML <a class="doclink" - * href="https://www.w3.org/TR/html5/embedded-content-0.html#the-audio-element";><audio></a> element. + * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#the-audio-element";><audio></a> + * element. * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> @@ -40,10 +40,13 @@ public class Audio extends HtmlElementContainer { /** * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-autoplay";>autoplay</a> * attribute. + * + * <p> * Hint that the media resource can be started automatically when the page is loaded. * - * @param autoplay The new value for this attribute. - * Typically a {@link Boolean} or {@link String}. + * @param autoplay + * The new value for this attribute. + * Typically a {@link Boolean} or {@link String}. * @return This object (for method chaining). */ public final Audio autoplay(Object autoplay) { @@ -54,10 +57,13 @@ public class Audio extends HtmlElementContainer { /** * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-controls";>controls</a> * attribute. + * + * <p> * Show user agent controls. * - * @param controls The new value for this attribute. - * Typically a {@link Boolean} or {@link String}. + * @param controls + * The new value for this attribute. + * Typically a {@link Boolean} or {@link String}. * @return This object (for method chaining). */ public final Audio controls(Object controls) { @@ -66,8 +72,10 @@ public class Audio extends HtmlElementContainer { } /** - * <a class="doclink" - * href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-crossorigin";>crossorigin</a> attribute. + * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-crossorigin";>crossorigin</a> + * attribute. + * + * <p> * How the element handles cross-origin requests. * * @param crossorigin The new value for this attribute. @@ -80,10 +88,13 @@ public class Audio extends HtmlElementContainer { /** * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-loop";>loop</a> attribute. + * + * <p> * Whether to loop the media resource. * - * @param loop The new value for this attribute. - * Typically a {@link Boolean} or {@link String}. + * @param loop + * The new value for this attribute. + * Typically a {@link Boolean} or {@link String}. * @return This object (for method chaining). */ public final Audio loop(Object loop) { @@ -94,6 +105,8 @@ public class Audio extends HtmlElementContainer { /** * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-mediagroup";>mediagroup</a> * attribute. + * + * <p> * Groups media elements together with an implicit MediaController. * * @param mediagroup The new value for this attribute. @@ -107,10 +120,13 @@ public class Audio extends HtmlElementContainer { /** * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-muted";>muted</a> * attribute. + * + * <p> * Whether to mute the media resource by default. * - * @param muted The new value for this attribute. - * Typically a {@link Boolean} or {@link String}. + * @param muted + * The new value for this attribute. + * Typically a {@link Boolean} or {@link String}. * @return This object (for method chaining). */ public final Audio muted(Object muted) { @@ -121,6 +137,8 @@ public class Audio extends HtmlElementContainer { /** * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-preload";>preload</a> * attribute. + * + * <p> * Hints how much buffering the media resource will likely need. * * @param preload The new value for this attribute. @@ -133,15 +151,20 @@ public class Audio extends HtmlElementContainer { /** * <a class="doclink" href="https://www.w3.org/TR/html5/embedded-content-0.html#attr-media-src";>src</a> attribute. + * + * <p> * Address of the resource. + * * <p> * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}. * Strings must be valid URIs. + * * <p> * URIs defined by {@link UriResolver} can be used for values. * - * @param src The new value for this attribute. - * Typically a {@link URL} or {@link String}. + * @param src + * The new value for this attribute. + * Typically a {@link URL} or {@link String}. * @return This object (for method chaining). */ public final Audio src(Object src) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java index 1712bfa..d4beaba 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/B.java @@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5; import org.apache.juneau.annotation.*; /** - * DTO for an HTML <a class="doclink" - * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-b-element";><b></a> element. + * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-b-element";><b></a> + * element. * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java index 16cf772..253be94 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Base.java @@ -19,8 +19,8 @@ import org.apache.juneau.*; import org.apache.juneau.annotation.*; /** - * DTO for an HTML <a class="doclink" - * href="https://www.w3.org/TR/html5/document-metadata.html#the-base-element";><base></a> element. + * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#the-base-element";><base></a> + * element. * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> @@ -39,15 +39,20 @@ public class Base extends HtmlElementVoid { /** * <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-base-href";>href</a> attribute. + * + * <p> * Document base URL. + * * <p> * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}. * Strings must be valid URIs. + * * <p> * URIs defined by {@link UriResolver} can be used for values. * - * @param href The new value for this attribute. - * Typically a {@link URL} or {@link String}. + * @param href + * The new value for this attribute. + * Typically a {@link URL} or {@link String}. * @return This object (for method chaining). */ public final Base href(Object href) { @@ -58,6 +63,8 @@ public class Base extends HtmlElementVoid { /** * <a class="doclink" href="https://www.w3.org/TR/html5/document-metadata.html#attr-base-target";>target</a> * attribute. + * + * <p> * Default browsing context for hyperlink navigation and form submission. * * @param target The new value for this attribute. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java index a9c9b06..bba51e5 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdi.java @@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5; import org.apache.juneau.annotation.*; /** - * DTO for an HTML <a class="doclink" - * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-bdi-element";><bdi></a> element. + * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-bdi-element";><bdi></a> + * element. * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java index 4e21958..b8c6acf 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Bdo.java @@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5; import org.apache.juneau.annotation.*; /** - * DTO for an HTML <a class="doclink" - * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-bdo-element";><bdo></a> element. + * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-bdo-element";><bdo></a> + * element. * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java index 57fd433..bcaa2db 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Blockquote.java @@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5; import org.apache.juneau.annotation.*; /** - * DTO for an HTML <a class="doclink" - * href="https://www.w3.org/TR/html5/grouping-content.html#the-blockquote-element";><blockquote></a> element. + * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#the-blockquote-element";><blockquote></a> + * element. * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> @@ -36,6 +36,8 @@ public class Blockquote extends HtmlElementMixed { /** * <a class="doclink" href="https://www.w3.org/TR/html5/grouping-content.html#attr-blockquote-cite";>cite</a> * attribute. + * + * <p> * Link to the source of the quotation. * * @param cite The new value for this attribute. http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java index 8fbd2a4..8bd8b3f 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Body.java @@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5; import org.apache.juneau.annotation.*; /** - * DTO for an HTML <a class="doclink" - * href="https://www.w3.org/TR/html5/sections.html#the-body-element";><body></a> element. + * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/sections.html#the-body-element";><body></a> + * element. * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> @@ -46,8 +46,8 @@ public class Body extends HtmlElementMixed { } /** - * <a class="doclink" - * href="https://www.w3.org/TR/html5/webappapis.html#handler-window-onbeforeunload";>onbeforeunload</a> attribute. + * <a class="doclink" href="https://www.w3.org/TR/html5/webappapis.html#handler-window-onbeforeunload";>onbeforeunload</a> + * attribute. * * @param onbeforeunload The new value for this attribute. * @return This object (for method chaining). http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java index f2c39c9..e7eba5e 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Br.java @@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5; import org.apache.juneau.annotation.*; /** - * DTO for an HTML <a class="doclink" - * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-br-element";><br></a> element. + * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-br-element";><br></a> + * element. * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java index fa9a75d..f2afd66 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Button.java @@ -19,8 +19,8 @@ import org.apache.juneau.*; import org.apache.juneau.annotation.*; /** - * DTO for an HTML <a class="doclink" - * href="https://www.w3.org/TR/html5/forms.html#the-button-element";><button></a> element. + * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#the-button-element";><button></a> + * element. * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> @@ -39,10 +39,13 @@ public class Button extends HtmlElementMixed { /** * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-autofocus";>autofocus</a> attribute. + * + * <p> * Automatically focus the form control when the page is loaded. * - * @param autofocus The new value for this attribute. - * Typically a {@link Boolean} or {@link String}. + * @param autofocus + * The new value for this attribute. + * Typically a {@link Boolean} or {@link String}. * @return This object (for method chaining). */ public final Button autofocus(Object autofocus) { @@ -52,10 +55,13 @@ public class Button extends HtmlElementMixed { /** * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-disabled";>disabled</a> attribute. + * + * <p> * Whether the form control is disabled. * - * @param disabled The new value for this attribute. - * Typically a {@link Boolean} or {@link String}. + * @param disabled + * The new value for this attribute. + * Typically a {@link Boolean} or {@link String}. * @return This object (for method chaining). */ public final Button disabled(Object disabled) { @@ -65,6 +71,8 @@ public class Button extends HtmlElementMixed { /** * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fae-form";>form</a> attribute. + * + * <p> * Associates the control with a form element. * * @param form The new value for this attribute. @@ -77,10 +85,14 @@ public class Button extends HtmlElementMixed { /** * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formaction";>formaction</a> attribute. + * + * <p> * URL to use for form submission. + * * <p> * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}. * Strings must be valid URIs. + * * <p> * URIs defined by {@link UriResolver} can be used for values. * @@ -94,6 +106,8 @@ public class Button extends HtmlElementMixed { /** * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formenctype";>formenctype</a> attribute. + * + * <p> * Form data set encoding type to use for form submission. * * @param formenctype The new value for this attribute. @@ -106,6 +120,8 @@ public class Button extends HtmlElementMixed { /** * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formmethod";>formmethod</a> attribute. + * + * <p> * HTTP method to use for form submission. * * @param formmethod The new value for this attribute. @@ -119,6 +135,8 @@ public class Button extends HtmlElementMixed { /** * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formnovalidate";>formnovalidate</a> * attribute. + * + * <p> * Bypass form control validation for form submission. * * @param formnovalidate The new value for this attribute. @@ -131,6 +149,8 @@ public class Button extends HtmlElementMixed { /** * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-formtarget";>formtarget</a> attribute. + * + * <p> * Browsing context for form submission. * * @param formtarget The new value for this attribute. @@ -143,6 +163,8 @@ public class Button extends HtmlElementMixed { /** * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fs-menu";>menu</a> attribute. + * + * <p> * Specifies the element's designated pop-up menu. * * @param menu The new value for this attribute. @@ -155,6 +177,8 @@ public class Button extends HtmlElementMixed { /** * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-fe-name";>name</a> attribute. + * + * <p> * Name of form control to use for form submission and in the form.elements API. * * @param name The new value for this attribute. @@ -167,6 +191,8 @@ public class Button extends HtmlElementMixed { /** * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-button-type";>type</a> attribute. + * + * <p> * Type of button. * * @param type The new value for this attribute. @@ -179,10 +205,13 @@ public class Button extends HtmlElementMixed { /** * <a class="doclink" href="https://www.w3.org/TR/html5/forms.html#attr-button-value";>value</a> attribute. + * + * <p> * Value to be used for form submission. * - * @param value The new value for this attribute. - * Typically a {@link Number} or {@link String}. + * @param value + * The new value for this attribute. + * Typically a {@link Number} or {@link String}. * @return This object (for method chaining). */ public final Button value(Object value) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java index eb95e4a..4881e63 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Canvas.java @@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5; import org.apache.juneau.annotation.*; /** - * DTO for an HTML <a class="doclink" - * href="https://www.w3.org/TR/html5/scripting-1.html#the-canvas-element";><canvas></a> element. + * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#the-canvas-element";><canvas></a> + * element. * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> @@ -35,10 +35,13 @@ public class Canvas extends HtmlElementContainer { /** * <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-canvas-height";>height</a> attribute. + * + * <p> * Vertical dimension. * - * @param height The new value for this attribute. - * Typically a {@link Number} or {@link String}. + * @param height + * The new value for this attribute. + * Typically a {@link Number} or {@link String}. * @return This object (for method chaining). */ public final Canvas height(Object height) { @@ -48,10 +51,13 @@ public class Canvas extends HtmlElementContainer { /** * <a class="doclink" href="https://www.w3.org/TR/html5/scripting-1.html#attr-canvas-width";>width</a> attribute. + * + * <p> * Horizontal dimension. * - * @param width The new value for this attribute. - * Typically a {@link Number} or {@link String}. + * @param width + * The new value for this attribute. + * Typically a {@link Number} or {@link String}. * @return This object (for method chaining). */ public final Canvas width(Object width) { http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java index a0da244..518b281 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Caption.java @@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5; import org.apache.juneau.annotation.*; /** - * DTO for an HTML <a class="doclink" - * href="https://www.w3.org/TR/html5/tabular-data.html#the-caption-element";><caption></a> element. + * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/tabular-data.html#the-caption-element";><caption></a> + * element. * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'> http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java ---------------------------------------------------------------------- diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java index f6a9b77..4e745ea 100644 --- a/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java +++ b/juneau-core/src/main/java/org/apache/juneau/dto/html5/Cite.java @@ -15,8 +15,8 @@ package org.apache.juneau.dto.html5; import org.apache.juneau.annotation.*; /** - * DTO for an HTML <a class="doclink" - * href="https://www.w3.org/TR/html5/text-level-semantics.html#the-cite-element";><cite></a> element. + * DTO for an HTML <a class="doclink" href="https://www.w3.org/TR/html5/text-level-semantics.html#the-cite-element";><cite></a> + * element. * * <h6 class='topic'>Additional Information</h6> * <ul class='doctree'>
