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 2018/01/14 16:02:48 UTC
[20/32] juneau git commit: Javadoc updates.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Bean.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Bean.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Bean.java
index adf0d7f..13faf8a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Bean.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Bean.java
@@ -23,14 +23,15 @@ import org.apache.juneau.transform.*;
/**
* Used to tailor how beans get interpreted by the framework.
- *
+ *
* <p>
* This annotation can be applied to classes and interfaces.
*
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanAnnotation">Overview > @Bean Annotation</a>
- * </ul>
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanAnnotation">Overview > @Bean Annotation</a>
+ * </ul>
*/
@Documented
@Target(TYPE)
@@ -40,7 +41,7 @@ public @interface Bean {
/**
* Bean dictionary.
- *
+ *
* <p>
* The list of classes that make up the bean dictionary for all properties in this class and all subclasses.
*
@@ -53,7 +54,7 @@ public @interface Bean {
/**
* Specifies a list of properties that should be excluded from {@link BeanMap#entrySet()}.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Exclude the 'city' and 'state' properties from the Address class.</jc>
@@ -70,18 +71,18 @@ 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>)
* <jk>public abstract class</jk> A {
* <jk>public</jk> String <jf>f0</jf> = <js>"f0"</js>;
* }
- *
+ *
* <jc>// Sub class</jc>
* <jk>public class</jk> A1 <jk>extends</jk> A {
* <jk>public</jk> String <jf>f1</jf> = <js>"f1"</js>;
@@ -90,11 +91,11 @@ public @interface Bean {
* <jc>// Produces "{f0:'f0'}"</jc>
* String json = JsonSerializer.<jsf>DEFAULT_LAX</jsf>.serialize(<jk>new</jk> A1());
* </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.
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanFilters}
@@ -104,11 +105,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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Address class with only street/city/state properties (in that order).</jc>
@@ -138,10 +139,10 @@ 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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Define a class with dashed-lowercase property names.</jc>
@@ -158,11 +159,11 @@ 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.
* <br>Otherwise, the natural order of the bean properties is used which is dependent on the JVM vendor.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Sort bean properties alphabetically during serialization.</jc>
@@ -179,11 +180,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>.
@@ -191,11 +192,11 @@ public @interface Bean {
* <jk>public class</jk> C1 {
* <jk>public int</jk> getP1();
* }
- *
+ *
* <jk>public class</jk> C2 <jk>extends</jk> C1 {
* <jk>public int</jk> getP2();
* }
- *
+ *
* <ja>@Bean</ja>(stopClass=C2.<jk>class</jk>)
* <jk>public class</jk> C3 <jk>extends</jk> C2 {
* <jk>public int</jk> getP3();
@@ -206,7 +207,7 @@ 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.
* <br>For example, if a bean property is of type <code>Object</code>, then the serializer will add the name to the
@@ -221,7 +222,7 @@ public @interface Bean {
* <ja>@Bean</ja>(typeName=<js>"mybean"</js>)
* <jk>public class</jk> MyBean {...}
* </p>
- *
+ *
* <h5 class='section'>See Also:</h5>
* <ul>
* <li class='jf'>{@link BeanContext#BEAN_beanDictionary}
@@ -231,10 +232,10 @@ 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 used by the {@link #typeName()} setting.
- *
+ *
* <p>
* The default value if not specified is <js>"_type"</js> .
*
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanConstructor.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
index ae4efe5..1a46a4c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanConstructor.java
@@ -21,31 +21,32 @@ 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>
* 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.
- *
+ *
* <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.
- *
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanConstructorAnnotation">Overview > @BeanConstructor Annotation</a>
- * </ul>
+ *
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanConstructorAnnotation">Overview > @BeanConstructor Annotation</a>
+ * </ul>
*/
@Documented
@Target(CONSTRUCTOR)
@@ -55,7 +56,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/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanIgnore.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanIgnore.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanIgnore.java
index 910ed00..6fe9a38 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanIgnore.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanIgnore.java
@@ -19,22 +19,23 @@ 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.
*
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanIgnoreAnnotation">Overview > @BeanIgnore Annotation</a>
- * </ul>
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanIgnoreAnnotation">Overview > @BeanIgnore Annotation</a>
+ * </ul>
*/
@Documented
@Target({FIELD,METHOD,TYPE})
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanProperty.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanProperty.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanProperty.java
index d57bb52..db5c7d0 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanProperty.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/BeanProperty.java
@@ -21,14 +21,15 @@ import org.apache.juneau.*;
/**
* Used tailor how bean properties get interpreted by the framework.
- *
+ *
* <p>
* This annotation is applied to public fields and public getter/setter methods of beans.
*
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanPropertyAnnotation">Overview > @BeanProperty Annotation</a>
- * </ul>
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.BeanPropertyAnnotation">Overview > @BeanProperty Annotation</a>
+ * </ul>
*/
@Documented
@Target({FIELD,METHOD})
@@ -38,16 +39,16 @@ 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.
- *
+ *
* <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
@@ -55,69 +56,69 @@ public @interface BeanProperty {
* 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'>
* <jc>// Option #1 - A simple public Map field.
* // The field name can be anything.</jc>
* <jk>public class</jk> BeanWithDynaField {
- *
+ *
* <ja>@BeanProperty</ja>(name=<js>"*"</js>)
* <jk>public</jk> Map<String,Object> extraStuff = <jk>new</jk> LinkedHashMap<String,Object>();
* }
- *
+ *
* <jc>// Option #2 - Getters and setters.
* // Method names can be anything.
* // Getter must return a Map with String keys.
* // Setter must take in two arguments.</jc>
* <jk>public class</jk> BeanWithDynaMethods {
- *
+ *
* <ja>@BeanProperty</ja>(name=<js>"*"</js>)
* <jk>public</jk> Map<String,Object> getMyExtraStuff() {
* ...
* }
- *
+ *
* <ja>@BeanProperty</ja>(name=<js>"*"</js>)
* <jk>public void</jk> setAnExtraField(String name, Object value) {
* ...
* }
* }
- *
+ *
* <jc>// Option #3 - Getter only.
* // Properties will be added through the getter.</jc>
* <jk>public class</jk> BeanWithDynaGetterOnly {
- *
+ *
* <ja>@BeanProperty</ja>(name=<js>"*"</js>)
* <jk>public</jk> Map<String,Object> getMyExtraStuff() {
* ...
* }
* }
* </p>
- *
+ *
*<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 {
- *
+ *
* <ja>@BeanProperty</ja>(name=<js>"*"</js>)
* <jk>public</jk> Map<String,List<String>> getMyExtraStuff() {
* ...
* }
* }
- *
+ *
* <jc>// A swapped value.</jc>
* <jk>public class</jk> BeanWithDynaFieldWithSwappedValues {
- *
+ *
* <ja>@BeanProperty</ja>(name=<js>"*"</js>, swap=CalendarSwap.<jsf>ISO8601DTZ</jsf>.<jk>class</jk>)
* <jk>public</jk> Map<String,Calendar> getMyExtraStuff() {
* ...
* }
* }
* </p>
- *
+ *
* <ul class='doctree'>
* <li class='info'>
* Note that if you're not interested in these additional properties, you can also use the
@@ -129,13 +130,13 @@ public @interface BeanProperty {
/**
* A synonym for {@link #name()}.
- *
+ *
* <p>
* The following annotations are equivalent:
- *
+ *
* <p class='bcode'>
* <ja>@BeanProperty</ja>(name=<js>"foo"</js>)
- *
+ *
* <ja>@BeanProperty</ja>(<js>"foo"</js>)
* </p>
*/
@@ -143,20 +144,20 @@ 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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jk>public class</jk> MyBean {
- *
+ *
* <jc>// Identify concrete map type.</jc>
* <ja>@BeanProperty</ja>(type=HashMap.<jk>class</jk>)
* <jk>public</jk> Map <jf>p1</jf>;
@@ -168,11 +169,11 @@ public @interface BeanProperty {
/**
* For bean properties of maps and collections, this annotation can be used to identify the class types of the
* contents of the bean property object when the generic parameter types are interfaces or abstract classes.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jk>public class</jk> MyBean {
- *
+ *
* <jc>// Identify concrete map type with String keys and Integer values.</jc>
* <ja>@BeanProperty</ja>(type=HashMap.<jk>class</jk>, params={String.<jk>class</jk>,Integer.<jk>class</jk>})
* <jk>public</jk> Map <jf>p1</jf>;
@@ -183,7 +184,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'>
@@ -192,21 +193,21 @@ public @interface BeanProperty {
* <li>Bean/Map arrays - Same, but applied to each element in the array.
* <li>Bean/Map collections - Same, but applied to each element in the collection.
* </ul>
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jk>public class</jk> MyClass {
- *
+ *
* <jc>// Only render 'f1' when serializing this bean property.</jc>
* <ja>@BeanProperty</ja>(properties=<js>"f1"</js>)
* <jk>public</jk> MyChildClass x1 = <jk>new</jk> MyChildClass();
* }
- *
+ *
* <jk>public class</jk> MyChildClass {
* <jk>public int</jk> f1 = 1;
* <jk>public int</jk> f2 = 2;
* }
- *
+ *
* <jc>// Renders "{x1:{f1:1}}"</jc>
* String json = JsonSerializer.<jsf>DEFAULT</jsf>.serialize(<jk>new</jk> MyClass());
* </p>
@@ -215,7 +216,7 @@ public @interface BeanProperty {
/**
* Bean dictionary.
- *
+ *
* <p>
* The list of classes that make up the bean dictionary this bean property.
*
@@ -228,14 +229,14 @@ 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.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@BeanProperty</ja>(format=<js>"$%.2f"</js>)
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/NameProperty.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/NameProperty.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/NameProperty.java
index e48f870..70236b4 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/NameProperty.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/NameProperty.java
@@ -19,16 +19,18 @@ import java.lang.annotation.*;
/**
* Identifies a setter as a method for setting the name of a POJO as it's known by its parent object.
- *
- * <h5 class='section'>Notes:</h5>
+ *
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul>
* <li>The annotated field or method does not need to be public.
* </ul>
*
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.NamePropertyAnnotation">Overview > @NameProperty Annotation</a>
- * </ul>
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.NamePropertyAnnotation">Overview > @NameProperty Annotation</a>
+ * </ul>
*/
@Target({METHOD,FIELD})
@Retention(RUNTIME)
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/ParentProperty.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/ParentProperty.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/ParentProperty.java
index 9c3e1e6..94fd8df 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/ParentProperty.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/ParentProperty.java
@@ -19,19 +19,21 @@ import java.lang.annotation.*;
/**
* 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.
- *
- * <h5 class='section'>Notes:</h5>
+ *
+ *
+ * <h5 class='topic'>Notes</h5>
* <ul>
* <li>The annotated field or method does not need to be public.
* </ul>
*
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.NamePropertyAnnotation">Overview > @NameProperty Annotation</a>
- * </ul>
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.NamePropertyAnnotation">Overview > @NameProperty Annotation</a>
+ * </ul>
*/
@Target({METHOD,FIELD})
@Retention(RUNTIME)
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swap.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swap.java
index f51f2ce..ab55d39 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swap.java
@@ -21,7 +21,7 @@ import org.apache.juneau.transform.*;
/**
* Associates {@link PojoSwap} and {@link Surrogate} classes with POJOs and bean properties.
- *
+ *
* <p>
* This annotation can be used in the following locations:
* <ul>
@@ -30,10 +30,11 @@ import org.apache.juneau.transform.*;
* <li>Inside the {@link Swaps @Swaps} annotation.
* </ul>
*
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.SwapAnnotation">Overview > @Swap Annotation</a>
- * </ul>
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.SwapAnnotation">Overview > @Swap Annotation</a>
+ * </ul>
*/
@Documented
@Target({TYPE,ANNOTATION_TYPE,FIELD,METHOD})
@@ -43,7 +44,7 @@ public @interface Swap {
/**
* The {@link PojoSwap} and {@link Surrogate} class.
- *
+ *
* <p>
* A synonym for {@link #value()}.
*/
@@ -51,14 +52,14 @@ public @interface Swap {
/**
* Identifies the media types that this swap is applicable for.
- *
+ *
* <p>
* In the following example, the swap is only invoked by the JSON serializer:
- *
+ *
* <p class='bcode'>
* <ja>@Swap</ja>(impl=ToStringSwap.<jk>class</jk>, mediaTypes=<js>"*/json"</js>)
* <jk>public class</jk> MyBean { ... }
- *
+ *
* <jk>public class</jk> ToStringSwap <jk>extends</jk> PojoSwap<Object,String> {
* <jk>public</jk> String swap(BeanSession session, Object o) <jk>throws</jk> Exception {
* <jk>return</jk> o.toString();
@@ -75,24 +76,24 @@ public @interface Swap {
/**
* Identifies a template string along with this swap.
- *
+ *
* <p>
* Template strings are arbitrary strings associated with swaps that help provide additional context information
* for the swap class.
* They're called 'templates' because their primary purpose is for providing template names, such as Apache FreeMarker
* template names.
- *
+ *
* <p>
* The following is an example of a templated swap class used to serialize POJOs to HTML using FreeMarker:
- *
+ *
* <p class='bcode'>
* <jc>// Our templated swap class.</jc>
* <jk>public class</jk> FreeMarkerSwap <jk>extends</jk> PojoSwap<Object,Reader> {
- *
+ *
* <jk>public</jk> MediaType[] forMediaTypes() {
* <jk>return</jk> MediaType.<jsm>forStrings</jsm>(<js>"*/html"</js>);
* }
- *
+ *
* <jk>public</jk> Reader swap(BeanSession session, Object o, String template) <jk>throws</jk> Exception {
* <jk>return</jk> getFreeMarkerReader(template, o); <jc>// Some method that creates raw HTML.</jc>
* }
@@ -112,7 +113,7 @@ public @interface Swap {
/**
* The {@link PojoSwap} and {@link Surrogate} class.
- *
+ *
* <p>
* A synonym for {@link #impl()}.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swaps.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swaps.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swaps.java
index 3ed934f..eac2a0b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swaps.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/Swaps.java
@@ -19,7 +19,7 @@ import java.lang.annotation.*;
/**
* Used to associate multiple swaps with the same POJO class.
- *
+ *
* <p class='bcode'>
* <ja>@Swaps</ja>(
* {
@@ -31,10 +31,11 @@ import java.lang.annotation.*;
* <jk>public class</jk> MyPojo {}
* </p>
*
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.SwapAnnotation">Overview > @Swap Annotation</a>
- * </ul>
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.SwapAnnotation">Overview > @Swap Annotation</a>
+ * </ul>
*/
@Documented
@Target({TYPE})
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/URI.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/URI.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/URI.java
index 985790b..28b497d 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/URI.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/annotation/URI.java
@@ -19,15 +19,16 @@ import java.lang.annotation.*;
/**
* Used to identify a class or bean property as a URI.
- *
+ *
* <p>
* This annotation allows you to identify other classes that return URIs via <code>toString()</code> as URI objects.
- *
*
- * <h6 class='topic'>Documentation</h6>
- * <ul>
- * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.URIAnnotation">Overview > @URI Annotation</a>
- * </ul>
+ *
+ *
+ * <h5 class='topic'>Documentation</h5>
+ * <ul>
+ * <li><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.URIAnnotation">Overview > @URI Annotation</a>
+ * </ul>
*/
@Documented
@Target({TYPE,FIELD,METHOD})
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParser.java
index 5bc8e66..f64daea 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParser.java
@@ -34,7 +34,7 @@ public class CsvParser extends ReaderParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public CsvParser(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserBuilder.java
index 9a8eeea..cfbd62c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserBuilder.java
@@ -32,7 +32,7 @@ public class CsvParserBuilder extends ParserBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public CsvParserBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserSession.java
index e1a866d..44fbc41 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvParserSession.java
@@ -17,7 +17,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 typically discarded after one-time use although it can be reused against multiple inputs.
@@ -26,7 +26,7 @@ public final class CsvParserSession extends ReaderParserSession {
/**
* 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.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializer.java
index 1bc274c..5239dfc 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializer.java
@@ -34,7 +34,7 @@ public final class CsvSerializer extends WriterSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public CsvSerializer(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerBuilder.java
index b1b3984..12c0ff9 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerBuilder.java
@@ -32,7 +32,7 @@ public class CsvSerializerBuilder extends SerializerBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public CsvSerializerBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java
index 2207228..fcac49a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/csv/CsvSerializerSession.java
@@ -20,7 +20,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 typically discarded after one-time use although it can be reused within the same thread.
@@ -29,7 +29,7 @@ public final class CsvSerializerSession extends WriterSerializerSession {
/**
* 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.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/Encoder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/Encoder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/Encoder.java
index 35ca3d8..05992db 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/Encoder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/Encoder.java
@@ -16,11 +16,12 @@ import java.io.*;
/**
* Used for enabling decompression on requests and compression on responses, such as support for GZIP compression.
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Used to wrap input and output streams within compression/decompression streams.
- *
+ *
* <p>
* Encoders are registered with <code>RestServlets</code> through the <ja>@RestResource.encoders()</ja> annotation.
*/
@@ -28,7 +29,7 @@ public abstract class Encoder {
/**
* Converts the specified compressed input stream into an uncompressed stream.
- *
+ *
* @param is The compressed stream.
* @return The uncompressed stream.
* @throws IOException If any errors occur, such as on a stream that's not a valid GZIP input stream.
@@ -37,7 +38,7 @@ public abstract class Encoder {
/**
* Converts the specified uncompressed output stream into an uncompressed stream.
- *
+ *
* @param os The uncompressed stream.
* @return The compressed stream stream.
* @throws IOException If any errors occur.
@@ -47,7 +48,7 @@ public abstract class Encoder {
/**
* Returns the codings in <code>Content-Encoding</code> and <code>Accept-Encoding</code> headers that this encoder
* handles (e.g. <js>"gzip"</js>).
- *
+ *
* @return The codings that this encoder handles.
*/
public abstract String[] getCodings();
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroup.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
index f7570ae..fca6e77 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
@@ -19,35 +19,36 @@ import org.apache.juneau.http.*;
/**
* Represents the group of {@link Encoder encoders} keyed by codings.
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* Maintains a set of encoders and the codings that they can handle.
- *
+ *
* <p>
* The {@link #getEncoderMatch(String)} and {@link #getEncoder(String)} methods are then used to find appropriate
* encoders for specific <code>Accept-Encoding</code> and <code>Content-Encoding</code> header values.
- *
+ *
* <h6 class='topic'>Match ordering</h6>
- *
+ *
* Encoders are matched against <code>Accept-Encoding</code> strings in the order they exist in this group.
- *
+ *
* <p>
* Adding new entries will cause the entries to be prepended to the group.
* This allows for previous encoders to be overridden through subsequent calls.
- *
+ *
* <p>
* For example, calling <code>groupBuilder.append(E1.<jk>class</jk>,E2.<jk>class</jk>).append(E3.<jk>class</jk>,
* E4.<jk>class</jk>)</code> will result in the order <code>E3, E4, E1, E2</code>.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <jc>// Create an encoder group with support for gzip compression.</jc>
* EncoderGroup g = EncoderGroup.<jsm>create</jsm>().append(GzipEncoder.<jk>class</jk>).build();
- *
+ *
* <jc>// Should return "gzip"</jc>
* String matchedCoding = g.findMatch(<js>"compress;q=1.0, gzip;q=0.8, identity;q=0.5, *;q=0"</js>);
- *
+ *
* <jc>// Get the encoder</jc>
* IEncoder encoder = g.getEncoder(matchedCoding);
* </p>
@@ -85,7 +86,7 @@ public final class EncoderGroup {
/**
* Constructor
- *
+ *
* @param encoders The encoders to add to this group.
*/
public EncoderGroup(Encoder[] encoders) {
@@ -108,13 +109,13 @@ public final class EncoderGroup {
/**
* Returns the coding string for the matching encoder that can handle the specified <code>Accept-Encoding</code>
* or <code>Content-Encoding</code> header value.
- *
+ *
* <p>
* Returns <jk>null</jk> if no encoders can handle it.
- *
+ *
* <p>
* This method is fully compliant with the RFC2616/14.3 and 14.11 specifications.
- *
+ *
* @param acceptEncoding The <code>Accept-Encoding</code> or <code>Content-Encoding</code> value.
* @return The coding value (e.g. <js>"gzip"</js>).
*/
@@ -136,7 +137,7 @@ public final class EncoderGroup {
/**
* Returns the encoder registered with the specified coding (e.g. <js>"gzip"</js>).
- *
+ *
* @param encoding The coding string.
* @return The encoder, or <jk>null</jk> if encoder isn't registered with that coding.
*/
@@ -147,7 +148,7 @@ public final class EncoderGroup {
/**
* Returns the set of codings supported by all encoders in this group.
- *
+ *
* @return An unmodifiable list of codings supported by all encoders in this group. Never <jk>null</jk>.
*/
public List<String> getSupportedEncodings() {
@@ -156,7 +157,7 @@ public final class EncoderGroup {
/**
* Returns the encoders in this group.
- *
+ *
* @return An unmodifiable list of encoders in this group.
*/
public List<Encoder> getEncoders() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
index a055a98..e00ab46 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
@@ -36,7 +36,7 @@ public class EncoderGroupBuilder {
/**
* Clone an existing encoder group builder.
- *
+ *
* @param copyFrom The encoder group that we're copying settings and encoders from.
*/
public EncoderGroupBuilder(EncoderGroup copyFrom) {
@@ -46,7 +46,7 @@ public class EncoderGroupBuilder {
/**
* Registers the specified encoders with this group.
- *
+ *
* @param e The encoders to append to this group.
* @return This object (for method chaining).
*/
@@ -58,7 +58,7 @@ public class EncoderGroupBuilder {
/**
* Registers the specified encoders with this group.
- *
+ *
* @param e The encoders to append to this group.
* @return This object (for method chaining).
*/
@@ -69,7 +69,7 @@ public class EncoderGroupBuilder {
/**
* Registers the specified encoders with this group.
- *
+ *
* @param e The encoders to append to this group.
* @return This object (for method chaining).
*/
@@ -80,7 +80,7 @@ public class EncoderGroupBuilder {
/**
* Registers the encoders in the specified group with this group.
- *
+ *
* @param eg The encoders to append to this group.
* @return This object (for method chaining).
*/
@@ -91,10 +91,10 @@ public class EncoderGroupBuilder {
/**
* Creates a new {@link EncoderGroup} object using a snapshot of the settings defined in this builder.
- *
+ *
* <p>
* This method can be called multiple times to produce multiple encoder groups.
- *
+ *
* @return A new {@link EncoderGroup} object.
*/
public EncoderGroup build() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderMatch.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderMatch.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderMatch.java
index f5ecb3d..9ba9e45 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderMatch.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/EncoderMatch.java
@@ -27,7 +27,7 @@ public final class EncoderMatch {
/**
* Returns the encoding of the encoder that matched the HTTP <code>Accept-Encoding</code> header value.
- *
+ *
* @return The encoding of the match.
*/
public String getEncoding() {
@@ -36,7 +36,7 @@ public final class EncoderMatch {
/**
* Returns the encoder that matched the HTTP <code>Accept-Encoding</code> header value.
- *
+ *
* @return The encoder of the match.
*/
public Encoder getEncoder() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/AnchorText.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/AnchorText.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/AnchorText.java
index 3fa31b4..d70f544 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/AnchorText.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/AnchorText.java
@@ -39,7 +39,7 @@ public enum AnchorText {
/**
* Set to the anchor of the URL.
- *
+ *
* <p>
* (e.g. <js>"http://localhost:9080/foobar#anchorTextHere"</js>)
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
index 8779d51..991927e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
@@ -28,7 +28,7 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Constructor.
- *
+ *
* @param bpm The metadata of the bean property of this additional metadata.
* @throws Exception If render class could not be instantiated.
*/
@@ -78,7 +78,7 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns whether this bean property should be serialized as XML instead of HTML.
- *
+ *
* @return <jk>true</jk> if the the {@link Html @Html} annotation is specified, and {@link Html#asXml() @Html.asXml()} is <jk>true</jk>.
*/
protected boolean isAsXml() {
@@ -87,7 +87,7 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns whether this bean property should be serialized as plain text instead of HTML.
- *
+ *
* @return
* <jk>true</jk> if the the {@link Html @Html} annotation is specified, and {@link Html#asPlainText() @Html.asPlainText()} is
* <jk>true</jk>.
@@ -98,7 +98,7 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns whether this bean property should not be serialized as an HTML table.
- *
+ *
* @return
* <jk>true</jk> if the the {@link Html @Html} annotation is specified, and {@link Html#noTables() @Html.noTables()} is
* <jk>true</jk>.
@@ -109,7 +109,7 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns whether this bean property should not include table headers when serialized as an HTML table.
- *
+ *
* @return
* <jk>true</jk> if the the {@link Html @Html} annotation is specified, and {@link Html#noTableHeaders() @Html.noTableHeaders()} is
* <jk>true</jk>.
@@ -120,10 +120,10 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns the render class for rendering the style and contents of this property value in HTML.
- *
+ *
* <p>
* This value is specified via the {@link Html#render() @Html.render()} annotation.
- *
+ *
* @return The render class, never <jk>null</jk>.
*/
public HtmlRender getRender() {
@@ -132,10 +132,10 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Adds a hyperlink to this value in HTML.
- *
+ *
* <p>
* This value is specified via the {@link Html#link() @Html.link()} annotation.
- *
+ *
* @return The link string, or <jk>null</jk> if not specified.
*/
public String getLink() {
@@ -144,10 +144,10 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Specifies the anchor text for this property.
- *
+ *
* <p>
* This value is specified via the {@link Html#anchorText() @Html.anchorText()} annotation.
- *
+ *
* @return The link string, or <jk>null</jk> if not specified.
*/
public String getAnchorText() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlClassMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlClassMeta.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlClassMeta.java
index fa1a016..a396958 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlClassMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlClassMeta.java
@@ -28,7 +28,7 @@ public class HtmlClassMeta extends ClassMetaExtended {
/**
* Constructor.
- *
+ *
* @param cm The class that this annotation is defined on.
*/
public HtmlClassMeta(ClassMeta<?> cm) {
@@ -51,7 +51,7 @@ public class HtmlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Html @Html} annotation defined on the class.
- *
+ *
* @return The value of the annotation, or <jk>null</jk> if not specified.
*/
protected Html getAnnotation() {
@@ -60,7 +60,7 @@ public class HtmlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Html#asXml() @Html.asXml()} annotation defined on the class.
- *
+ *
* @return The value of the annotation.
*/
protected boolean isAsXml() {
@@ -69,7 +69,7 @@ public class HtmlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Html#asPlainText() @Html.asPlainText()} annotation defined on the class.
- *
+ *
* @return The value of the annotation.
*/
protected boolean isAsPlainText() {
@@ -78,7 +78,7 @@ public class HtmlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Html#noTables() @Html.noTables()} annotation defined on the class.
- *
+ *
* @return The value of the annotation.
*/
protected boolean isNoTables() {
@@ -87,7 +87,7 @@ public class HtmlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Html#noTableHeaders() @Html.noTableHeaders()} annotation defined on the class.
- *
+ *
* @return The value of the annotation.
*/
public boolean isNoTableHeaders() {
@@ -96,7 +96,7 @@ public class HtmlClassMeta extends ClassMetaExtended {
/**
* Returns the {@link Html#render() @Html.render()} annotation defined on the class.
- *
+ *
* @return The value of the annotation.
*/
public HtmlRender<?> getRender() {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java
index 13306ad..467fe5e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializer.java
@@ -17,22 +17,24 @@ import org.apache.juneau.serializer.*;
/**
* Serializes POJOs to HTTP responses as HTML documents.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Accept</code> types: <code>text/html</code>
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Accept</code> types: <code><b>text/html</b></code>
* <p>
- * Produces <code>Content-Type</code> types: <code>text/html</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ * Produces <code>Content-Type</code> types: <code><b>text/html</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* 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.
- *
+ *
* <p>
* Configurable properties are typically specified via <ja>@RestResource.properties()</ja> and <ja>@RestMethod.properties()</ja>
* annotations, although they can also be set programmatically via the <code>RestResponse.setProperty()</code> method.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -45,7 +47,7 @@ import org.apache.juneau.serializer.*;
* )
* <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
* </p>
- *
+ *
* <p>
* Note that shortcut annotations are also provided for these particular settings:
* <p class='bcode'>
@@ -61,7 +63,7 @@ import org.apache.juneau.serializer.*;
* )
* )
* </p>
- *
+ *
* <p>
* The <code>$L{...}</code> variable represent localized strings pulled from the resource bundle identified by the
* <code>messages</code> annotation.
@@ -78,7 +80,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: Aside section contents.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.aside.ls"</js>
@@ -86,16 +88,16 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Allows you to specify the contents of the aside section on the HTML page.
* The aside section floats on the right of the page for providing content supporting the serialized content of
* the page.
- *
+ *
* <p>
* By default, the aside section is empty.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -115,7 +117,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: Footer section contents.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.footer.ls"</js>
@@ -123,14 +125,14 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Allows you to specify the contents of the footer section on the HTML page.
- *
+ *
* <p>
* By default, the footer section is empty.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -146,7 +148,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: Additional head section content.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.head.ls"</js>
@@ -154,11 +156,11 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Adds the specified HTML content to the head section of the page.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -168,7 +170,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* }
* )
* </p>
- *
+ *
* <p>
* A shortcut on <ja>@RestResource</ja> is also provided for this setting:
* <p class='bcode'>
@@ -185,7 +187,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: Header section contents.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.ls"</js>
@@ -193,12 +195,12 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Allows you to override the contents of the header section on the HTML page.
* The header section normally contains the title and description at the top of the page.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -214,7 +216,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: Nav section contents.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.nav.ls"</js>
@@ -222,12 +224,12 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Allows you to override the contents of the nav section on the HTML page.
* The nav section normally contains the page links at the top of the page.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -238,7 +240,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* )
* )
* </p>
- *
+ *
* <p>
* When this property is specified, the {@link #HTMLDOC_navlinks} property is ignored.
*/
@@ -246,7 +248,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: Page navigation links.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.navlinks.ls"</js>
@@ -254,14 +256,14 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Adds a list of hyperlinks immediately under the title and description but above the content of the page.
- *
+ *
* <p>
* This can be used to provide convenient hyperlinks when viewing the REST interface from a browser.
- *
+ *
* <p>
* The value is an array of strings with two possible values:
* <ul>
@@ -269,7 +271,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <br><js>"google: http://google.com"</js>
* <li>Arbitrary HTML.
* </ul>
- *
+ *
* <p>
* Relative URLs are considered relative to the servlet path.
* For example, if the servlet path is <js>"http://localhost/myContext/myServlet"</js>, and the
@@ -277,7 +279,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* Absolute (<js>"/myOtherContext/foo"</js>) and fully-qualified (<js>"http://localhost2/foo"</js>) URLs
* can also be used in addition to various other protocols specified by {@link UriResolver} such as
* <js>"servlet:/..."</js>.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p>
* The <code>AddressBookResource</code> sample class uses this property...
@@ -290,11 +292,11 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* )
* <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
* </p>
- *
+ *
* <p>
* ...to produce this list of links on the HTML page...
* <img class='bordered' src='doc-files/HTML_LINKS.png'>
- *
+ *
* <p>
* A shortcut on <ja>@RestResource</ja> is also provided for this setting:
* <p class='bcode'>
@@ -318,7 +320,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: No-results message.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.noResultsMessage.s"</js>
@@ -326,11 +328,11 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> <js>"<p>no results</p>"</js>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Allows you to specify the string message used when trying to serialize an empty array or empty list.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -339,7 +341,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* )
* )
* </p>
- *
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -347,7 +349,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: Prevent word wrap on page.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.nowrap.b"</js>
@@ -355,7 +357,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Adds <js>"* {white-space:nowrap}"</js> to the CSS instructions on the page to prevent word wrapping.
@@ -364,7 +366,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: Javascript code.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.script.ls"</js>
@@ -372,11 +374,11 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Adds the specified Javascript code to the HTML page.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -386,7 +388,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* }
* )
* </p>
- *
+ *
* <p>
* A shortcut on <ja>@RestResource</ja> is also provided for this setting:
* <p class='bcode'>
@@ -408,7 +410,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: CSS style code.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.style.ls"</js>
@@ -416,11 +418,11 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Adds the specified CSS instructions to the HTML page.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -430,7 +432,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* }
* )
* </p>
- *
+ *
* <p>
* A shortcut on <ja>@RestResource</ja> is also provided for this setting:
* <p class='bcode'>
@@ -453,7 +455,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: Stylesheet import URLs.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.stylesheet.ls"</js>
@@ -461,11 +463,11 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Adds a link to the specified stylesheet URL.
- *
+ *
* <p>
* Note that this stylesheet is controlled by the <code><ja>@RestResource</ja>.stylesheet()</code> annotation.
*/
@@ -478,7 +480,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Configuration property: HTML document template.
- *
+ *
* <h5 class='section'>Property:</h5>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.template.c"</js>
@@ -486,15 +488,15 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
* <li><b>Default:</b> <code>HtmlDocTemplateBasic.<jk>class</jk></code>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
- *
+ *
* <h5 class='section'>Description:</h5>
* <p>
* Specifies the template to use for serializing the page.
- *
+ *
* <p>
* By default, the {@link HtmlDocTemplateBasic} class is used to construct the contents of the HTML page, but
* can be overridden with your own custom implementation class.
- *
+ *
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -526,7 +528,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public HtmlDocSerializer(PropertyStore ps) {
@@ -535,7 +537,7 @@ public class HtmlDocSerializer extends HtmlStrippedDocSerializer {
/**
* Constructor.
- *
+ *
* @param ps
* The property store containing all the settings for this object.
* @param produces
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java
index 2d8fcfc..f152d07 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocSerializerSession.java
@@ -21,10 +21,10 @@ import org.apache.juneau.serializer.*;
/**
* Context object that lives for the duration of a single serialization of {@link HtmlSerializer} and its subclasses.
- *
+ *
* <p>
* See {@link Serializer} for details.
- *
+ *
* <p>
* This class is NOT thread safe. It is meant to be discarded after one-time use.
*/
@@ -38,7 +38,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* 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.
@@ -85,7 +85,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_style} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_style} setting value in this context.
* An empty array if not specified.
@@ -97,7 +97,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_stylesheet} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_stylesheet} setting value in this context.
* An empty array if not specified.
@@ -109,7 +109,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_script} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_script} setting value in this context.
* An empty array if not specified.
@@ -121,7 +121,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_head} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_head} setting value in this context.
* An empty array if not specified.
@@ -133,7 +133,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_nowrap} setting value in this context.
- *
+ *
* @return The {@link HtmlDocSerializer#HTMLDOC_nowrap} setting value in this context.
*/
public final boolean isNoWrap() {
@@ -142,7 +142,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_header} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_header} setting value in this context.
* <jk>null</jk> if not specified.
@@ -154,7 +154,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_navlinks} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_navlinks} setting value in this context.
* <jk>null</jk> if not specified.
@@ -166,7 +166,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the template to use for generating the HTML page.
- *
+ *
* @return
* The HTML page generator.
* Never <jk>null</jk>.
@@ -177,7 +177,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_nav} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_nav} setting value in this context.
* <jk>null</jk> if not specified.
@@ -189,7 +189,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_aside} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_aside} setting value in this context.
* <jk>null</jk> if not specified.
@@ -201,7 +201,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_footer} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_footer} setting value in this context.
* <jk>null</jk> if not specified.
@@ -213,7 +213,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Returns the {@link HtmlDocSerializer#HTMLDOC_noResultsMessage} setting value in this context.
- *
+ *
* @return
* The {@link HtmlDocSerializer#HTMLDOC_noResultsMessage} setting value in this context.
* <jk>null</jk> if not specified.
@@ -242,7 +242,7 @@ public class HtmlDocSerializerSession extends HtmlStrippedDocSerializerSession {
/**
* Calls the parent {@link #doSerialize(SerializerPipe, Object)} method which invokes just the HTML serializer.
- *
+ *
* @param out
* Where to send the output from the serializer.
* @param o The object being serialized.
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java
index 562bac9..dc50c51 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplate.java
@@ -15,7 +15,7 @@ package org.apache.juneau.html;
/**
* Defines the interface for rendering the contents of an HTML page produced by the {@link HtmlDocSerializer}
* serializer.
- *
+ *
* <p>
* The HTML doc serializer produces the following document structure with the typical contents:
* <p class='bcode'>
@@ -49,7 +49,7 @@ package org.apache.juneau.html;
* </body>
* </html></xt>
* </p>
- *
+ *
* <p>
* This interface allows you to control how these sections get rendered.
*/
@@ -57,7 +57,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><head></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param o The object being serialized.
@@ -67,7 +67,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><head></xt>/<xt><style></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param o The object being serialized.
@@ -77,7 +77,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><head></xt>/<xt><script></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param o The object being serialized.
@@ -87,7 +87,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><body></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param o The object being serialized.
@@ -97,7 +97,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><body></xt>/<xt><header></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param o The object being serialized.
@@ -107,7 +107,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><body></xt>/<xt><nav></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param o The object being serialized.
@@ -117,7 +117,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><body></xt>/<xt><article></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param o The object being serialized.
@@ -127,7 +127,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><body></xt>/<xt><aside></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param o The object being serialized.
@@ -137,7 +137,7 @@ public interface HtmlDocTemplate {
/**
* Renders the contents of the <code><xt><body></xt>/<xt><footer></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @param w The writer being written to.
* @param o The object being serialized.
@@ -147,7 +147,7 @@ public interface HtmlDocTemplate {
/**
* Returns <jk>true</jk> if this page should render a <code><xt><head></xt>/<xt><style></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @return A boolean flag.
*/
@@ -155,7 +155,7 @@ public interface HtmlDocTemplate {
/**
* Returns <jk>true</jk> if this page should render a <code><xt><head></xt>/<xt><script></xt></code> element.
- *
+ *
* @param session The current serializer session.
* @return A boolean flag.
*/
@@ -164,7 +164,7 @@ public interface HtmlDocTemplate {
/**
* Returns <jk>true</jk> if this page should render a <code><xt><body></xt>/<xt><header></xt></code>
* element.
- *
+ *
* @param session The current serializer session.
* @return A boolean flag.
*/
@@ -173,7 +173,7 @@ public interface HtmlDocTemplate {
/**
* Returns <jk>true</jk> if this page should render a <code><xt><body></xt>/<xt><nav></xt></code>
* element.
- *
+ *
* @param session The current serializer session.
* @return A boolean flag.
*/
@@ -182,7 +182,7 @@ public interface HtmlDocTemplate {
/**
* Returns <jk>true</jk> if this page should render a <code><xt><body></xt>/<xt><aside></xt></code>
* element.
- *
+ *
* @param session The current serializer session.
* @return A boolean flag.
*/
@@ -191,7 +191,7 @@ public interface HtmlDocTemplate {
/**
* Returns <jk>true</jk> if this page should render a <code><xt><body></xt>/<xt><footer></xt></code>
* element.
- *
+ *
* @param session The current serializer session.
* @return A boolean flag.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java
index 1869306..596f758 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlDocTemplateBasic.java
@@ -16,7 +16,7 @@ import org.apache.juneau.internal.*;
/**
* A basic template for the HTML doc serializer.
- *
+ *
* <p>
* This class can be subclassed to customize page rendering.
*/
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlLink.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlLink.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlLink.java
index 39fba6f..716ff0a 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlLink.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlLink.java
@@ -19,13 +19,13 @@ import java.lang.annotation.*;
/**
* Used in conjunction with the {@link HtmlSerializer} class to define hyperlinks.
- *
+ *
* <p>
* This annotation is applied to classes.
- *
+ *
* <p>
* Annotation that can be used to specify that a class has a URL associated with it.
- *
+ *
* <p>
* When rendered using the {@link org.apache.juneau.html.HtmlSerializer HtmlSerializer} class, this class will get
* rendered as a hyperlink like so...
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParser.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParser.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParser.java
index 48356e3..1a23296 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParser.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParser.java
@@ -18,13 +18,15 @@ import org.apache.juneau.xml.*;
/**
* Parses text generated by the {@link HtmlSerializer} class back into a POJO model.
- *
- * <h5 class='section'>Media types:</h5>
- *
- * Handles <code>Content-Type</code> types: <code>text/html</code>
- *
- * <h5 class='section'>Description:</h5>
- *
+ *
+ *
+ * <h5 class='topic'>Media types</h5>
+ *
+ * Handles <code>Content-Type</code> types: <code><b>text/html</b></code>
+ *
+ *
+ * <h5 class='topic'>Description</h5>
+ *
* 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.
@@ -45,7 +47,7 @@ public class HtmlParser extends XmlParser {
/**
* Constructor.
- *
+ *
* @param ps The property store containing all the settings for this object.
*/
public HtmlParser(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserBuilder.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserBuilder.java
index 6966fa4..d5d4dad 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserBuilder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserBuilder.java
@@ -36,7 +36,7 @@ public class HtmlParserBuilder extends XmlParserBuilder {
/**
* Constructor.
- *
+ *
* @param ps The initial configuration settings for this builder.
*/
public HtmlParserBuilder(PropertyStore ps) {
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserSession.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserSession.java
index 61c532e..f7d5d84 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlParserSession.java
@@ -28,7 +28,7 @@ import org.apache.juneau.xml.*;
/**
* Session object that lives for the duration of a single use of {@link HtmlParser}.
- *
+ *
* <p>
* This class is NOT thread safe.
* It is typically discarded after one-time use although it can be reused against multiple inputs.
@@ -44,7 +44,7 @@ public final class HtmlParserSession extends XmlParserSession {
/**
* Create a new session using properties specified in the context.
- *
+ *
* @param ctx
* The context creating this session object.
* The context contains all the configuration settings for this object.
@@ -520,7 +520,7 @@ public final class HtmlParserSession extends XmlParserSession {
* <p>
* Precondition: Pointing to opening tag.
* Postcondition: Pointing to next opening tag.
- *
+ *
* @param r The stream being read from.
* @throws XMLStreamException
*/
@@ -573,11 +573,11 @@ public final class HtmlParserSession extends XmlParserSession {
/**
* Parses CHARACTERS data.
- *
+ *
* <p>
* Precondition: Pointing to event immediately following opening tag.
* Postcondition: Pointing to closing tag.
- *
+ *
* @param r The stream being read from.
* @return The parsed string.
* @throws XMLStreamException
@@ -664,11 +664,11 @@ public final class HtmlParserSession extends XmlParserSession {
/**
* Identical to {@link #parseText(XmlReader)} except assumes the current event is the opening tag.
- *
+ *
* <p>
* Precondition: Pointing to opening tag.
* Postcondition: Pointing to closing tag.
- *
+ *
* @param r The stream being read from.
* @return The parsed string.
* @throws XMLStreamException
http://git-wip-us.apache.org/repos/asf/juneau/blob/5686b8d6/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlRender.java
----------------------------------------------------------------------
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlRender.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlRender.java
index 90e9898..d7ffa0c 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlRender.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/html/HtmlRender.java
@@ -17,51 +17,51 @@ import org.apache.juneau.serializer.*;
/**
* Allows custom rendering of bean property values when serialized as HTML.
- *
+ *
* <p>
* Associated with bean properties using the {@link Html#render() @Html.render()} annotation.
- *
+ *
* <p>
* Using this class, you can alter the CSS style and HTML content of the bean property.
- *
+ *
* <p>
* The following example shows two render classes that customize the appearance of the <code>pctFull</code> and
* <code>status</code> columns shown below:
- *
+ *
* <p>
* <img class='bordered' src='doc-files/HtmlRender_1.png'>
- *
+ *
* <p class='bcode'>
* <jc>// Our bean class</jc>
* <jk>public class</jk> FileSpace {
- *
+ *
* <jk>private final</jk> String <jf>drive</jf>;
* <jk>private final long</jk> <jf>total</jf>, <jf>available</jf>;
- *
+ *
* <jk>public</jk> FileSpace(String drive, <jk>long</jk> total, <jk>long</jk> available) {
* <jk>this</jk>.<jf>drive</jf> = drive;
* <jk>this</jk>.<jf>total</jf> = total;
* <jk>this</jk>.<jf>available</jf> = available;
* }
- *
+ *
* <ja>@Html</ja>(link=<js>"drive/{drive}"</js>)
* <jk>public</jk> String getDrive() {
* <jk>return</jk> <jf>drive</jf>;
* }
- *
+ *
* <jk>public long</jk> getTotal() {
* <jk>return</jk> <jf>total</jf>;
* }
- *
+ *
* <jk>public long</jk> getAvailable() {
* <jk>return</jk> <jf>available</jf>;
* }
- *
+ *
* <ja>@Html</ja>(render=FileSpacePctRender.<jk>class</jk>)
* <jk>public float</jk> getPctFull() {
* <jk>return</jk> ((100 * <jf>available</jf>) / <jf>total</jf>);
* }
- *
+ *
* <ja>@Html</ja>(render=FileSpaceStatusRender.<jk>class</jk>)
* <jk>public</jk> FileSpaceStatus getStatus() {
* <jk>float</jk> pf = getPctFull();
@@ -72,15 +72,15 @@ import org.apache.juneau.serializer.*;
* <jk>return</jk> FileSpaceStatus.<jsf>SEVERE</jsf>;
* }
* }
- *
+ *
* <jc>// Possible values for the getStatus() method</jc>
* <jk>public static enum</jk> FileSpaceStatus {
* <jsf>OK</jsf>, <jsf>WARNING</jsf>, <jsf>SEVERE</jsf>;
* }
- *
+ *
* <jc>// Custom render for getPctFull() method</jc>
* <jk>public static class</jk> FileSpacePctRender <jk>extends</jk> HtmlRender<Float> {
- *
+ *
* <ja>@Override</ja>
* <jk>public</jk> String getStyle(SerializerSession session, Float value) {
* <jk>if</jk> (value < 80)
@@ -89,7 +89,7 @@ import org.apache.juneau.serializer.*;
* <jk>return</jk> <js>"background-color:yellow;text-align:center"</js>;
* <jk>return</jk> <js>"background-color:red;text-align:center;border:;animation:color_change 0.5s infinite alternate"</js>;
* }
- *
+ *
* <ja>@Override</ja>
* <jk>public</jk> Object getContent(SerializerSession session, Float value) {
* <jk>if</jk> (value >= 90)
@@ -100,15 +100,15 @@ import org.apache.juneau.serializer.*;
* <jk>return</jk> String.<jsm>format</jsm>(<js>"%.0f%%"</js>, value);
* }
* }
- *
+ *
* <jc>// Custom render for getStatus() method</jc>
* <jk>public static class</jk> FileSpaceStatusRender <jk>extends</jk> HtmlRender<FileSpaceStatus> {
- *
+ *
* <ja>@Override</ja>
* <jk>public</jk> String getStyle(SerializerSession session, FileSpaceStatus value) {
* <jk>return</jk> <js>"text-align:center"</js>;
* }
- *
+ *
* <ja>@Override</ja>
* <jk>public</jk> Object getContent(SerializerSession session, FileSpaceStatus value) {
* <jk>switch</jk> (value) {
@@ -119,14 +119,14 @@ import org.apache.juneau.serializer.*;
* }
* }
* </p>
- *
+ *
* @param <T> The bean property type.
*/
public abstract class HtmlRender<T> {
/**
* Returns the CSS style of the element containing the bean property value.
- *
+ *
* @param session
* The current serializer session.
* Can be used to retrieve properties and session-level information.
@@ -139,11 +139,11 @@ public abstract class HtmlRender<T> {
/**
* Returns the delegate value for the specified bean property value.
- *
+ *
* <p>
* The default implementation simply returns the same value.
* A typical use is to return an HTML element using one of the HTML5 DOM beans.
- *
+ *
* @param session
* The current serializer session.
* Can be used to retrieve properties and session-level information.