You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2017/06/28 01:49:48 UTC
[9/9] incubator-juneau git commit: Clean up javadocs.
Clean up javadocs.
Project: http://git-wip-us.apache.org/repos/asf/incubator-juneau/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-juneau/commit/19c566dd
Tree: http://git-wip-us.apache.org/repos/asf/incubator-juneau/tree/19c566dd
Diff: http://git-wip-us.apache.org/repos/asf/incubator-juneau/diff/19c566dd
Branch: refs/heads/master
Commit: 19c566dd2898e5093037fdf15c6542c2bb734c4e
Parents: 0d913b3
Author: JamesBognar <ja...@apache.org>
Authored: Tue Jun 27 21:49:34 2017 -0400
Committer: JamesBognar <ja...@apache.org>
Committed: Tue Jun 27 21:49:34 2017 -0400
----------------------------------------------------------------------
.../apache/juneau/BeanPropertyMetaExtended.java | 3 +
.../org/apache/juneau/BeanPropertyValue.java | 6 +-
.../juneau/BeanProxyInvocationHandler.java | 5 +-
.../java/org/apache/juneau/BeanRegistry.java | 8 +-
.../java/org/apache/juneau/BeanSession.java | 115 +++++++----
.../main/java/org/apache/juneau/ClassMeta.java | 202 +++++++++++--------
.../org/apache/juneau/ClassMetaExtended.java | 8 +-
.../main/java/org/apache/juneau/Context.java | 7 +-
.../main/java/org/apache/juneau/CoreObject.java | 26 +--
.../org/apache/juneau/CoreObjectBuilder.java | 132 ++++++++++--
.../main/java/org/apache/juneau/Delegate.java | 2 +
.../juneau/InvalidDataConversionException.java | 1 +
.../main/java/org/apache/juneau/ObjectList.java | 78 ++++---
.../main/java/org/apache/juneau/ObjectMap.java | 186 +++++++++++------
.../java/org/apache/juneau/PropertyNamer.java | 7 +-
.../org/apache/juneau/PropertyNamerDefault.java | 1 +
.../java/org/apache/juneau/PropertyStore.java | 22 +-
.../main/java/org/apache/juneau/Session.java | 22 +-
.../main/java/org/apache/juneau/Streamable.java | 4 +-
.../main/java/org/apache/juneau/UriContext.java | 50 +++--
.../java/org/apache/juneau/UriResolver.java | 17 +-
.../main/java/org/apache/juneau/Visibility.java | 18 +-
.../main/java/org/apache/juneau/Writable.java | 4 +-
.../java/org/apache/juneau/annotation/Bean.java | 46 +++--
.../juneau/annotation/BeanConstructor.java | 11 +-
.../apache/juneau/annotation/BeanIgnore.java | 3 +
.../org/apache/juneau/annotation/BeanParam.java | 2 +-
.../apache/juneau/annotation/BeanProperty.java | 30 ++-
.../org/apache/juneau/annotation/Consumes.java | 6 +-
.../apache/juneau/annotation/NameProperty.java | 12 +-
.../juneau/annotation/ParentProperty.java | 3 +-
.../java/org/apache/juneau/annotation/Pojo.java | 1 +
.../org/apache/juneau/annotation/Produces.java | 4 +
.../apache/juneau/annotation/ThreadSafe.java | 1 +
.../java/org/apache/juneau/annotation/URI.java | 5 +
.../org/apache/juneau/csv/CsvParserContext.java | 3 +
.../org/apache/juneau/csv/CsvParserSession.java | 39 ++--
.../apache/juneau/csv/CsvSerializerContext.java | 3 +
.../apache/juneau/csv/CsvSerializerSession.java | 21 +-
.../main/java/org/apache/juneau/dto/Link.java | 11 +-
.../org/apache/juneau/dto/ResultSetList.java | 5 +-
.../org/apache/juneau/dto/atom/AtomBuilder.java | 5 +
.../org/apache/juneau/dto/atom/Category.java | 3 +-
.../java/org/apache/juneau/dto/atom/Common.java | 2 +
.../org/apache/juneau/dto/atom/Content.java | 2 +
.../java/org/apache/juneau/dto/atom/Feed.java | 1 +
.../org/apache/juneau/dto/atom/Generator.java | 2 +
.../java/org/apache/juneau/dto/atom/Icon.java | 4 +
.../java/org/apache/juneau/dto/atom/Link.java | 1 +
.../java/org/apache/juneau/dto/atom/Logo.java | 4 +
.../java/org/apache/juneau/dto/atom/Person.java | 2 +
.../java/org/apache/juneau/dto/atom/Text.java | 1 +
.../org/apache/juneau/dto/cognos/Column.java | 8 +-
.../org/apache/juneau/dto/cognos/DataSet.java | 8 +-
.../java/org/apache/juneau/dto/html5/A.java | 29 ++-
.../java/org/apache/juneau/dto/html5/Abbr.java | 4 +-
.../org/apache/juneau/dto/html5/Address.java | 4 +-
.../java/org/apache/juneau/dto/html5/Area.java | 34 +++-
.../org/apache/juneau/dto/html5/Article.java | 4 +-
.../java/org/apache/juneau/dto/html5/Aside.java | 4 +-
.../java/org/apache/juneau/dto/html5/Audio.java | 51 +++--
.../java/org/apache/juneau/dto/html5/B.java | 4 +-
.../java/org/apache/juneau/dto/html5/Base.java | 15 +-
.../java/org/apache/juneau/dto/html5/Bdi.java | 4 +-
.../java/org/apache/juneau/dto/html5/Bdo.java | 4 +-
.../org/apache/juneau/dto/html5/Blockquote.java | 6 +-
.../java/org/apache/juneau/dto/html5/Body.java | 8 +-
.../java/org/apache/juneau/dto/html5/Br.java | 4 +-
.../org/apache/juneau/dto/html5/Button.java | 45 ++++-
.../org/apache/juneau/dto/html5/Canvas.java | 18 +-
.../org/apache/juneau/dto/html5/Caption.java | 4 +-
.../java/org/apache/juneau/dto/html5/Cite.java | 4 +-
.../java/org/apache/juneau/dto/html5/Code.java | 4 +-
.../java/org/apache/juneau/dto/html5/Col.java | 11 +-
.../org/apache/juneau/dto/html5/Colgroup.java | 12 +-
.../java/org/apache/juneau/dto/html5/Data.java | 11 +-
.../org/apache/juneau/dto/html5/Datalist.java | 4 +-
.../java/org/apache/juneau/dto/html5/Dd.java | 4 +-
.../java/org/apache/juneau/dto/html5/Del.java | 8 +-
.../java/org/apache/juneau/dto/html5/Dfn.java | 4 +-
.../java/org/apache/juneau/dto/html5/Div.java | 4 +-
.../java/org/apache/juneau/dto/html5/Dl.java | 4 +-
.../java/org/apache/juneau/dto/html5/Dt.java | 4 +-
.../java/org/apache/juneau/dto/html5/Em.java | 4 +-
.../java/org/apache/juneau/dto/html5/Embed.java | 29 ++-
.../org/apache/juneau/dto/html5/Fieldset.java | 15 +-
.../org/apache/juneau/dto/html5/Figcaption.java | 4 +-
.../org/apache/juneau/dto/html5/Figure.java | 4 +-
.../org/apache/juneau/dto/html5/Footer.java | 4 +-
.../java/org/apache/juneau/dto/html5/Form.java | 24 ++-
.../java/org/apache/juneau/dto/html5/H1.java | 4 +-
.../java/org/apache/juneau/dto/html5/H2.java | 4 +-
.../java/org/apache/juneau/dto/html5/H3.java | 4 +-
.../java/org/apache/juneau/dto/html5/H4.java | 4 +-
.../java/org/apache/juneau/dto/html5/H5.java | 4 +-
.../java/org/apache/juneau/dto/html5/H6.java | 4 +-
.../java/org/apache/juneau/dto/html5/Head.java | 4 +-
.../org/apache/juneau/dto/html5/Header.java | 4 +-
.../java/org/apache/juneau/dto/html5/Hr.java | 4 +-
.../java/org/apache/juneau/dto/html5/Html.java | 6 +-
.../apache/juneau/dto/html5/HtmlElement.java | 46 +++--
.../juneau/dto/html5/HtmlElementContainer.java | 2 +
.../juneau/dto/html5/HtmlElementMixed.java | 12 +-
.../juneau/dto/html5/HtmlElementText.java | 2 +-
.../juneau/dto/html5/HtmlElementVoid.java | 1 +
.../java/org/apache/juneau/dto/html5/I.java | 4 +-
.../org/apache/juneau/dto/html5/Iframe.java | 33 ++-
.../java/org/apache/juneau/dto/html5/Img.java | 44 ++--
.../java/org/apache/juneau/dto/html5/Input.java | 127 +++++++++---
.../java/org/apache/juneau/dto/html5/Ins.java | 4 +
.../java/org/apache/juneau/dto/html5/Kbd.java | 4 +-
.../org/apache/juneau/dto/html5/Keygen.java | 26 ++-
.../java/org/apache/juneau/dto/html5/Label.java | 4 +
.../org/apache/juneau/dto/html5/Legend.java | 4 +-
.../java/org/apache/juneau/dto/html5/Li.java | 4 +-
.../java/org/apache/juneau/dto/html5/Link.java | 29 ++-
.../java/org/apache/juneau/dto/html5/Main.java | 4 +-
.../java/org/apache/juneau/dto/html5/Map.java | 6 +-
.../java/org/apache/juneau/dto/html5/Mark.java | 4 +-
.../java/org/apache/juneau/dto/html5/Meta.java | 12 +-
.../java/org/apache/juneau/dto/html5/Meter.java | 42 ++--
.../org/apache/juneau/dto/html5/Noscript.java | 4 +-
.../org/apache/juneau/dto/html5/Object2.java | 43 ++--
.../java/org/apache/juneau/dto/html5/Ol.java | 20 +-
.../org/apache/juneau/dto/html5/Optgroup.java | 13 +-
.../org/apache/juneau/dto/html5/Option.java | 27 ++-
.../org/apache/juneau/dto/html5/Output.java | 10 +-
.../java/org/apache/juneau/dto/html5/P.java | 4 +-
.../java/org/apache/juneau/dto/html5/Param.java | 13 +-
.../java/org/apache/juneau/dto/html5/Pre.java | 4 +-
.../org/apache/juneau/dto/html5/Progress.java | 18 +-
.../java/org/apache/juneau/dto/html5/Q.java | 6 +-
.../java/org/apache/juneau/dto/html5/Rb.java | 4 +-
.../java/org/apache/juneau/dto/html5/Rp.java | 4 +-
.../java/org/apache/juneau/dto/html5/Rt.java | 4 +-
.../java/org/apache/juneau/dto/html5/Rtc.java | 4 +-
.../java/org/apache/juneau/dto/html5/Ruby.java | 4 +-
.../java/org/apache/juneau/dto/html5/S.java | 4 +-
.../java/org/apache/juneau/dto/html5/Samp.java | 4 +-
.../org/apache/juneau/dto/html5/Script.java | 33 ++-
.../org/apache/juneau/dto/html5/Section.java | 4 +-
.../org/apache/juneau/dto/html5/Select.java | 43 ++--
.../java/org/apache/juneau/dto/html5/Small.java | 4 +-
.../org/apache/juneau/dto/html5/Source.java | 15 +-
.../java/org/apache/juneau/dto/html5/Span.java | 4 +-
.../org/apache/juneau/dto/html5/Strong.java | 4 +-
.../java/org/apache/juneau/dto/html5/Style.java | 8 +-
.../java/org/apache/juneau/dto/html5/Sub.java | 4 +-
.../java/org/apache/juneau/dto/html5/Sup.java | 4 +-
.../java/org/apache/juneau/dto/html5/Table.java | 9 +-
.../java/org/apache/juneau/dto/html5/Tbody.java | 4 +-
.../java/org/apache/juneau/dto/html5/Td.java | 20 +-
.../org/apache/juneau/dto/html5/Template.java | 4 +-
.../org/apache/juneau/dto/html5/Textarea.java | 74 +++++--
.../java/org/apache/juneau/dto/html5/Tfoot.java | 4 +-
.../java/org/apache/juneau/dto/html5/Th.java | 26 ++-
.../java/org/apache/juneau/dto/html5/Thead.java | 4 +-
.../java/org/apache/juneau/dto/html5/Time.java | 6 +-
.../java/org/apache/juneau/dto/html5/Title.java | 4 +-
.../java/org/apache/juneau/dto/html5/Tr.java | 4 +-
.../java/org/apache/juneau/dto/html5/Track.java | 21 +-
.../java/org/apache/juneau/dto/html5/U.java | 4 +-
.../java/org/apache/juneau/dto/html5/Ul.java | 4 +-
.../java/org/apache/juneau/dto/html5/Var.java | 4 +-
.../java/org/apache/juneau/dto/html5/Video.java | 71 +++++--
.../java/org/apache/juneau/dto/html5/Wbr.java | 4 +-
.../apache/juneau/dto/jsonschema/JsonType.java | 7 +-
.../juneau/dto/jsonschema/JsonTypeArray.java | 3 +-
.../apache/juneau/dto/jsonschema/Schema.java | 142 ++++++++-----
.../apache/juneau/dto/jsonschema/SchemaMap.java | 12 ++
.../jsonschema/SchemaPropertySimpleArray.java | 1 +
.../apache/juneau/dto/jsonschema/SchemaRef.java | 3 +
.../org/apache/juneau/dto/swagger/Contact.java | 7 +
.../dto/swagger/ExternalDocumentation.java | 11 +-
.../apache/juneau/dto/swagger/HeaderInfo.java | 64 +++++-
.../org/apache/juneau/dto/swagger/Info.java | 16 +-
.../org/apache/juneau/dto/swagger/Items.java | 59 +++++-
.../org/apache/juneau/dto/swagger/License.java | 7 +
.../apache/juneau/dto/swagger/Operation.java | 87 +++++---
.../juneau/dto/swagger/ParameterInfo.java | 104 +++++++++-
.../apache/juneau/dto/swagger/ResponseInfo.java | 22 ++
.../apache/juneau/dto/swagger/SchemaInfo.java | 48 +++--
.../juneau/dto/swagger/SecurityScheme.java | 43 +++-
.../org/apache/juneau/dto/swagger/Swagger.java | 121 ++++++++++-
.../juneau/dto/swagger/SwaggerBuilder.java | 27 +--
.../java/org/apache/juneau/dto/swagger/Tag.java | 22 +-
.../java/org/apache/juneau/dto/swagger/Xml.java | 23 +++
.../org/apache/juneau/encoders/Encoder.java | 6 +-
.../apache/juneau/encoders/EncoderGroup.java | 15 +-
.../juneau/encoders/EncoderGroupBuilder.java | 1 +
.../juneau/html/HtmlBeanPropertyMeta.java | 17 +-
.../juneau/html/HtmlDocSerializerContext.java | 66 +++++-
.../juneau/html/HtmlDocSerializerSession.java | 88 +++++---
.../org/apache/juneau/html/HtmlDocTemplate.java | 2 +
.../juneau/html/HtmlDocTemplateBasic.java | 1 +
.../java/org/apache/juneau/html/HtmlLink.java | 3 +
.../java/org/apache/juneau/html/HtmlParser.java | 2 +-
.../apache/juneau/html/HtmlParserBuilder.java | 1 +
.../apache/juneau/html/HtmlParserContext.java | 3 +
.../apache/juneau/html/HtmlParserSession.java | 29 ++-
.../java/org/apache/juneau/html/HtmlRender.java | 15 +-
.../juneau/html/HtmlSchemaDocSerializer.java | 3 +
.../org/apache/juneau/html/HtmlSerializer.java | 33 +--
.../juneau/html/HtmlSerializerBuilder.java | 15 +-
.../juneau/html/HtmlSerializerContext.java | 16 ++
.../juneau/html/HtmlSerializerSession.java | 26 ++-
.../juneau/html/HtmlStrippedDocSerializer.java | 2 +
.../org/apache/juneau/html/annotation/Html.java | 14 +-
.../java/org/apache/juneau/http/Accept.java | 21 +-
.../org/apache/juneau/http/AcceptCharset.java | 7 +
.../org/apache/juneau/http/AcceptEncoding.java | 7 +
.../org/apache/juneau/http/AcceptLanguage.java | 12 ++
.../org/apache/juneau/http/AcceptRanges.java | 5 +
.../main/java/org/apache/juneau/http/Age.java | 5 +
.../main/java/org/apache/juneau/http/Allow.java | 7 +
.../org/apache/juneau/http/Authorization.java | 5 +
.../org/apache/juneau/http/CacheControl.java | 5 +
.../java/org/apache/juneau/http/Connection.java | 7 +
.../org/apache/juneau/http/ContentEncoding.java | 6 +
.../org/apache/juneau/http/ContentLanguage.java | 6 +
.../org/apache/juneau/http/ContentLength.java | 5 +
.../org/apache/juneau/http/ContentLocation.java | 6 +
.../org/apache/juneau/http/ContentRange.java | 14 ++
.../org/apache/juneau/http/ContentType.java | 3 +
.../main/java/org/apache/juneau/http/Date.java | 13 +-
.../main/java/org/apache/juneau/http/ETag.java | 3 +
.../org/apache/juneau/http/EntityValidator.java | 1 +
.../java/org/apache/juneau/http/Expect.java | 7 +
.../java/org/apache/juneau/http/Expires.java | 11 +
.../main/java/org/apache/juneau/http/From.java | 6 +
.../java/org/apache/juneau/http/HeaderDate.java | 1 +
.../juneau/http/HeaderEntityValidator.java | 1 +
.../juneau/http/HeaderEntityValidatorArray.java | 1 +
.../java/org/apache/juneau/http/HeaderEnum.java | 2 +
.../org/apache/juneau/http/HeaderInteger.java | 2 +
.../apache/juneau/http/HeaderRangeArray.java | 2 +
.../org/apache/juneau/http/HeaderString.java | 2 +
.../apache/juneau/http/HeaderStringArray.java | 2 +
.../java/org/apache/juneau/http/HeaderUri.java | 2 +
.../main/java/org/apache/juneau/http/Host.java | 5 +
.../java/org/apache/juneau/http/HttpMethod.java | 1 +
.../java/org/apache/juneau/http/IfMatch.java | 12 ++
.../org/apache/juneau/http/IfModifiedSince.java | 10 +
.../org/apache/juneau/http/IfNoneMatch.java | 10 +
.../java/org/apache/juneau/http/IfRange.java | 7 +-
.../apache/juneau/http/IfUnmodifiedSince.java | 8 +
.../org/apache/juneau/http/LastModified.java | 7 +
.../java/org/apache/juneau/http/Location.java | 4 +
.../org/apache/juneau/http/MaxForwards.java | 5 +
.../java/org/apache/juneau/http/MediaType.java | 19 +-
.../org/apache/juneau/http/MediaTypeRange.java | 19 +-
.../java/org/apache/juneau/http/Pragma.java | 7 +
.../apache/juneau/http/ProxyAuthenticate.java | 3 +
.../apache/juneau/http/ProxyAuthorization.java | 3 +
.../main/java/org/apache/juneau/http/Range.java | 17 ++
.../java/org/apache/juneau/http/Referer.java | 4 +
.../java/org/apache/juneau/http/RetryAfter.java | 5 +
.../java/org/apache/juneau/http/Server.java | 5 +
.../org/apache/juneau/http/StringRange.java | 26 ++-
.../main/java/org/apache/juneau/http/TE.java | 35 ++--
.../java/org/apache/juneau/http/Trailer.java | 5 +
.../apache/juneau/http/TransferEncoding.java | 6 +
.../java/org/apache/juneau/http/Upgrade.java | 9 +
.../java/org/apache/juneau/http/UserAgent.java | 3 +
.../main/java/org/apache/juneau/http/Vary.java | 6 +-
.../main/java/org/apache/juneau/http/Via.java | 14 ++
.../java/org/apache/juneau/http/Warning.java | 14 ++
.../org/apache/juneau/http/WwwAuthenticate.java | 3 +
268 files changed, 3169 insertions(+), 1076 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMetaExtended.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMetaExtended.java b/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMetaExtended.java
index b7d630b..43362f2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMetaExtended.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanPropertyMetaExtended.java
@@ -14,6 +14,7 @@ package org.apache.juneau;
/**
* Defines extended language-specific metadata associated with a bean property.
+ *
* <p>
* Serializers and parsers can implement their own language-specific metadata on a bean property and retrieve
* the metadata using the {@link BeanPropertyMeta#getExtendedMeta(Class)} method.
@@ -24,6 +25,7 @@ public class BeanPropertyMetaExtended {
/**
* Constructor.
+ *
* @param bpm The metadata of the bean property we're extending.
* @throws BeanRuntimeException If any error occurred trying to construct the metadata.
*/
@@ -33,6 +35,7 @@ public class BeanPropertyMetaExtended {
/**
* Returns the bean property metadata that was passed into the constructor.
+ *
* @return The bean property metadata that was passed into the constructor.
*/
protected BeanPropertyMeta getBeanPropertyMeta() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/BeanPropertyValue.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanPropertyValue.java b/juneau-core/src/main/java/org/apache/juneau/BeanPropertyValue.java
index 856968c..4e5812c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanPropertyValue.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanPropertyValue.java
@@ -14,7 +14,6 @@ package org.apache.juneau;
/**
* Represents a simple bean property value and the meta-data associated with it.
- * <p>
*/
public class BeanPropertyValue implements Comparable<BeanPropertyValue> {
@@ -40,6 +39,7 @@ public class BeanPropertyValue implements Comparable<BeanPropertyValue> {
/**
* Returns the bean property metadata.
+ *
* @return The bean property metadata.
*/
public final BeanPropertyMeta getMeta() {
@@ -48,6 +48,7 @@ public class BeanPropertyValue implements Comparable<BeanPropertyValue> {
/**
* Returns the bean property metadata.
+ *
* @return The bean property metadata.
*/
public final ClassMeta<?> getClassMeta() {
@@ -56,6 +57,7 @@ public class BeanPropertyValue implements Comparable<BeanPropertyValue> {
/**
* Returns the bean property name.
+ *
* @return The bean property name.
*/
public final String getName() {
@@ -64,6 +66,7 @@ public class BeanPropertyValue implements Comparable<BeanPropertyValue> {
/**
* Returns the bean property value.
+ *
* @return The bean property value.
*/
public final Object getValue() {
@@ -72,6 +75,7 @@ public class BeanPropertyValue implements Comparable<BeanPropertyValue> {
/**
* Returns the exception thrown by calling the property getter.
+ *
* @return The exception thrown by calling the property getter.
*/
public final Throwable getThrown() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/BeanProxyInvocationHandler.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanProxyInvocationHandler.java b/juneau-core/src/main/java/org/apache/juneau/BeanProxyInvocationHandler.java
index 57bd0be..27ac252 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanProxyInvocationHandler.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanProxyInvocationHandler.java
@@ -19,9 +19,10 @@ import org.apache.juneau.json.*;
/**
* Provides an {@link InvocationHandler} for creating beans from bean interfaces.
+ *
* <p>
- * If the {@code useInterfaceProxies} setting is enabled in {@link BeanContext}, this
- * is the class that creates instances of beans from interfaces.
+ * If the {@code useInterfaceProxies} setting is enabled in {@link BeanContext}, this is the class that creates
+ * instances of beans from interfaces.
*
* @param <T> The interface class
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/BeanRegistry.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanRegistry.java b/juneau-core/src/main/java/org/apache/juneau/BeanRegistry.java
index 83f9b42..fb11738 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanRegistry.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanRegistry.java
@@ -23,10 +23,13 @@ import org.apache.juneau.internal.*;
/**
* A lookup table for resolving bean types by name.
+ *
* <p>
* In a nutshell, provides a simple mapping of bean class objects to identifying names.
+ *
* <p>
* Class names are defined through the {@link Bean#typeName()} annotation.
+ *
* <p>
* The dictionary is used by the framework in the following ways:
* <ul>
@@ -116,8 +119,9 @@ public class BeanRegistry {
/**
* Gets the class metadata for the specified bean type name.
*
- * @param typeName The bean type name as defined by {@link Bean#typeName()}.
- * Can include multi-dimensional array type names (e.g. <js>"X^^"</js>).
+ * @param typeName
+ * The bean type name as defined by {@link Bean#typeName()}.
+ * Can include multi-dimensional array type names (e.g. <js>"X^^"</js>).
* @return The class metadata for the bean.
*/
public ClassMeta<?> getClassMeta(String typeName) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/BeanSession.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/BeanSession.java b/juneau-core/src/main/java/org/apache/juneau/BeanSession.java
index b8ed6ec..353c65b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/BeanSession.java
+++ b/juneau-core/src/main/java/org/apache/juneau/BeanSession.java
@@ -30,6 +30,7 @@ import org.apache.juneau.transform.*;
/**
* Session object that lives for the duration of a single use of {@link Serializer} or {@link Parser}.
+ *
* <p>
* This class is NOT thread safe. It is meant to be discarded after one-time use.
*/
@@ -46,14 +47,18 @@ public class BeanSession extends Session {
/**
* Create a new session using properties specified in the context.
*
- * @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 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 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 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>).
*/
protected BeanSession(BeanContext ctx, ObjectMap op, Locale locale, TimeZone timeZone, MediaType mediaType) {
@@ -76,6 +81,7 @@ public class BeanSession extends Session {
/**
* Returns the locale defined on this session.
+ *
* <p>
* The locale is determined in the following order:
* <ol>
@@ -93,6 +99,8 @@ public class BeanSession extends Session {
/**
* Returns the timezone defined on this session.
+ *
+ * <p>
* The timezone is determined in the following order:
* <ol>
* <li><code>timeZone</code> parameter passed in through constructor.
@@ -117,6 +125,8 @@ public class BeanSession extends Session {
/**
* Bean property getter: <property>ignoreUnknownBeanProperties</property>.
+ *
+ * <p>
* See {@link BeanContext#BEAN_ignoreUnknownBeanProperties}.
*
* @return The value of the <property>ignoreUnknownBeanProperties</property> property on this bean.
@@ -127,6 +137,7 @@ public class BeanSession extends Session {
/**
* Converts the specified value to the specified class type.
+ *
* <p>
* See {@link #convertToType(Object, ClassMeta)} for the list of valid conversions.
*
@@ -148,8 +159,9 @@ public class BeanSession extends Session {
* be instantiated within another class instance.
*
* @param <T> The class type to convert the value to.
- * @param outer If class is a member class, this is the instance of the containing class.
- * Should be <jk>null</jk> if not a member class.
+ * @param outer
+ * If class is a member class, this is the instance of the containing class.
+ * Should be <jk>null</jk> if not a member class.
* @param value The value to convert.
* @param type The class type to convert the value to.
* @throws InvalidDataConversionException If the specified value cannot be converted to the specified type.
@@ -161,8 +173,10 @@ public class BeanSession extends Session {
/**
* Casts the specified value into the specified type.
+ *
* <p>
* If the value isn't an instance of the specified type, then converts the value if possible.
+ *
* <p>
* The following conversions are valid:
* <table class='styled'>
@@ -298,11 +312,12 @@ public class BeanSession extends Session {
/**
* Same as {@link #convertToType(Object, ClassMeta)}, except used for instantiating inner member classes that must
- * be instantiated within another class instance.
+ * be instantiated within another class instance.
*
* @param <T> The class type to convert the value to.
- * @param outer If class is a member class, this is the instance of the containing class.
- * Should be <jk>null</jk> if not a member class.
+ * @param outer
+ * If class is a member class, this is the instance of the containing class.
+ * Should be <jk>null</jk> if not a member class.
* @param value The value to convert.
* @param type The class type to convert the value to.
* @throws InvalidDataConversionException If the specified value cannot be converted to the specified type.
@@ -624,12 +639,14 @@ public class BeanSession extends Session {
/**
* Converts the contents of the specified list into an array.
+ *
* <p>
* Works on both object and primitive arrays.
+ *
* <p>
- * In the case of multi-dimensional arrays, the incoming list must
- * contain elements of type n-1 dimension. i.e. if {@code type} is <code><jk>int</jk>[][]</code>
- * then {@code list} must have entries of type <code><jk>int</jk>[]</code>.
+ * In the case of multi-dimensional arrays, the incoming list must contain elements of type n-1 dimension.
+ * i.e. if {@code type} is <code><jk>int</jk>[][]</code> then {@code list} must have entries of type
+ * <code><jk>int</jk>[]</code>.
*
* @param type The type to convert to. Must be an array type.
* @param list The contents to populate the array with.
@@ -662,6 +679,7 @@ public class BeanSession extends Session {
/**
* Wraps an object inside a {@link BeanMap} object (i.e. a modifiable {@link Map}).
+ *
* <p>
* If object is not a true bean, then throws a {@link BeanRuntimeException} with an explanation of why it's not a
* bean.
@@ -703,8 +721,9 @@ public class BeanSession extends Session {
}
/**
- * Wraps an object inside a {@link BeanMap} object (i.e.: a modifiable {@link Map})
- * defined as a bean for one of its class, a super class, or an implemented interface.
+ * Wraps an object inside a {@link BeanMap} object (i.e.: a modifiable {@link Map}) defined as a bean for one of its
+ * class, a super class, or an implemented interface.
+ *
* <p>
* If object is not a true bean, throws a {@link BeanRuntimeException} with an explanation of why it's not a bean.
*
@@ -723,8 +742,9 @@ public class BeanSession extends Session {
* @return The bean representation, or <jk>null</jk> if the object is not a true bean.
* @throws NullPointerException If either parameter is null.
* @throws IllegalArgumentException If the specified object is not an an instance of the specified class.
- * @throws BeanRuntimeException If specified object is not a bean according to the bean rules
- * specified in this context class.
+ * @throws
+ * BeanRuntimeException If specified object is not a bean according to the bean rules specified in this context
+ * class.
*/
public final <T> BeanMap<T> toBeanMap(T o, Class<? super T> c) throws BeanRuntimeException {
assertFieldNotNull(o, "o");
@@ -744,6 +764,7 @@ public class BeanSession extends Session {
/**
* Creates a new {@link BeanMap} object (i.e. a modifiable {@link Map}) of the given class with uninitialized
* property values.
+ *
* <p>
* If object is not a true bean, then throws a {@link BeanRuntimeException} with an explanation of why it's not a
* bean.
@@ -763,13 +784,14 @@ public class BeanSession extends Session {
}
/**
- * Same as {@link #newBeanMap(Class)}, except used for instantiating inner member classes that must
- * be instantiated within another class instance.
+ * Same as {@link #newBeanMap(Class)}, except used for instantiating inner member classes that must be instantiated
+ * within another class instance.
*
* @param <T> The class of the object being wrapped.
* @param c The name of the class to create a new instance of.
- * @param outer If class is a member class, this is the instance of the containing class.
- * Should be <jk>null</jk> if not a member class.
+ * @param outer
+ * If class is a member class, this is the instance of the containing class.
+ * Should be <jk>null</jk> if not a member class.
* @return A new instance of the class.
*/
public final <T> BeanMap<T> newBeanMap(Object outer, Class<T> c) {
@@ -802,13 +824,14 @@ public class BeanSession extends Session {
}
/**
- * Same as {@link #newBean(Class)}, except used for instantiating inner member classes that must
- * be instantiated within another class instance.
+ * Same as {@link #newBean(Class)}, except used for instantiating inner member classes that must be instantiated
+ * within another class instance.
*
* @param <T> The class type of the bean being created.
* @param c The class type of the bean being created.
- * @param outer If class is a member class, this is the instance of the containing class.
- * Should be <jk>null</jk> if not a member class.
+ * @param outer
+ * If class is a member class, this is the instance of the containing class.
+ * Should be <jk>null</jk> if not a member class.
* @return A new bean object.
* @throws BeanRuntimeException If the specified class is not a valid bean.
*/
@@ -834,7 +857,8 @@ public class BeanSession extends Session {
*
* @param <T> The class type to get the meta-data on.
* @param c The class to get the meta-data on.
- * @return The {@link BeanMeta} for the specified class, or <jk>null</jk> if the class
+ * @return
+ * The {@link BeanMeta} for the specified class, or <jk>null</jk> if the class
* is not a bean per the settings on this context.
*/
public final <T> BeanMeta<T> getBeanMeta(Class<T> c) {
@@ -857,12 +881,15 @@ public class BeanSession extends Session {
/**
* Used to resolve <code>ClassMetas</code> of type <code>Collection</code> and <code>Map</code> that have
* <code>ClassMeta</code> values that themselves could be collections or maps.
+ *
* <p>
* <code>Collection</code> meta objects are assumed to be followed by zero or one meta objects indicating the
* element type.
+ *
* <p>
* <code>Map</code> meta objects are assumed to be followed by zero or two meta objects indicating the key and value
* types.
+ *
* <p>
* The array can be arbitrarily long to indicate arbitrarily complex data structures.
*
@@ -899,6 +926,8 @@ public class BeanSession extends Session {
/**
* Given an array of {@link Type} objects, returns a {@link ClassMeta} representing those arguments.
+ *
+ * <p>
* Constructs a new meta on each call.
*
* @param classes The array of classes to get class metas for.
@@ -928,8 +957,9 @@ public class BeanSession extends Session {
/**
* Returns the type property name as defined by {@link BeanContext#BEAN_beanTypePropertyName}.
*
- * @param cm The class meta of the type we're trying to resolve the type name for.
- * Can be <jk>null</jk>.
+ * @param cm
+ * The class meta of the type we're trying to resolve the type name for.
+ * Can be <jk>null</jk>.
* @return The type property name. Never <jk>null</jk>.
*/
public final String getBeanTypePropertyName(ClassMeta cm) {
@@ -948,6 +978,7 @@ public class BeanSession extends Session {
/**
* Creates a reusable {@link StringBuilder} object from an internal pool.
+ *
* <p>
* String builders are returned to the pool by calling {@link #returnStringBuilder(StringBuilder)}.
*
@@ -973,12 +1004,13 @@ public class BeanSession extends Session {
/**
* Returns a reusable {@link ClassMeta} representation for the class <code>Object</code>.
+ *
* <p>
- * This <code>ClassMeta</code> is often used to represent "any object type" when an object type
- * is not known.
+ * This <code>ClassMeta</code> is often used to represent "any object type" when an object type is not known.
+ *
* <p>
- * This method is identical to calling <code>getClassMeta(Object.<jk>class</jk>)</code> but uses
- * a cached copy to avoid a hashmap lookup.
+ * This method is identical to calling <code>getClassMeta(Object.<jk>class</jk>)</code> but uses a cached copy to
+ * avoid a hashmap lookup.
*
* @return The {@link ClassMeta} object associated with the <code>Object</code> class.
*/
@@ -988,11 +1020,13 @@ public class BeanSession extends Session {
/**
* Returns a reusable {@link ClassMeta} representation for the class <code>String</code>.
+ *
* <p>
* This <code>ClassMeta</code> is often used to represent key types in maps.
+ *
* <p>
- * This method is identical to calling <code>getClassMeta(String.<jk>class</jk>)</code> but uses
- * a cached copy to avoid a hashmap lookup.
+ * This method is identical to calling <code>getClassMeta(String.<jk>class</jk>)</code> but uses a cached copy to
+ * avoid a hashmap lookup.
*
* @return The {@link ClassMeta} object associated with the <code>String</code> class.
*/
@@ -1002,11 +1036,13 @@ public class BeanSession extends Session {
/**
* Returns a reusable {@link ClassMeta} representation for the class <code>Class</code>.
+ *
* <p>
* This <code>ClassMeta</code> is often used to represent key types in maps.
+ *
* <p>
- * This method is identical to calling <code>getClassMeta(Class.<jk>class</jk>)</code> but uses
- * a cached copy to avoid a hashmap lookup.
+ * This method is identical to calling <code>getClassMeta(Class.<jk>class</jk>)</code> but uses a cached copy to
+ * avoid a hashmap lookup.
*
* @return The {@link ClassMeta} object associated with the <code>String</code> class.
*/
@@ -1025,6 +1061,7 @@ public class BeanSession extends Session {
/**
* Returns the media type specified for this session.
+ *
* <p>
* For example, <js>"application/json"</js>.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java b/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java
index 7e7d640..0e1bd72 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ClassMeta.java
@@ -34,11 +34,11 @@ import org.apache.juneau.transform.*;
import org.apache.juneau.utils.*;
/**
- * A wrapper class around the {@link Class} object that provides cached information
- * about that class.
+ * A wrapper class around the {@link Class} object that provides cached information about that class.
*
* <p>
* Instances of this class can be created through the {@link BeanContext#getClassMeta(Class)} method.
+ *
* <p>
* The {@link BeanContext} class will cache and reuse instances of this class except for the following class types:
* <ul>
@@ -46,9 +46,10 @@ import org.apache.juneau.utils.*;
* <li>Maps with non-Object key/values.
* <li>Collections with non-Object key/values.
* </ul>
+ *
* <p>
- * This class is tied to the {@link BeanContext} class because it's that class that makes the determination
- * of what is a bean.
+ * This class is tied to the {@link BeanContext} class because it's that class that makes the determination of what is
+ * a bean.
*
* @param <T> The class type of the wrapped class.
*/
@@ -119,17 +120,22 @@ public final class ClassMeta<T> implements Type {
*
* @param innerClass The class being wrapped.
* @param beanContext The bean context that created this object.
- * @param implClass For interfaces and abstract classes, this represents the "real" class to instantiate.
- * Can be <jk>null</jk>.
- * @param beanFilter The {@link BeanFilter} programmatically associated with this class.
- * Can be <jk>null</jk>.
- * @param pojoSwap The {@link PojoSwap} programmatically associated with this class.
- * Can be <jk>null</jk>.
- * @param childPojoSwap The child {@link PojoSwap PojoSwaps} programmatically associated with this class.
- * These are the <code>PojoSwaps</code> that have normal classes that are subclasses of this class.
- * Can be <jk>null</jk>.
- * @param delayedInit Don't call init() in constructor.
- * Used for delayed initialization when the possibility of class reference loops exist.
+ * @param implClass
+ * For interfaces and abstract classes, this represents the "real" class to instantiate.
+ * Can be <jk>null</jk>.
+ * @param beanFilter
+ * The {@link BeanFilter} programmatically associated with this class.
+ * Can be <jk>null</jk>.
+ * @param pojoSwap
+ * The {@link PojoSwap} programmatically associated with this class.
+ * Can be <jk>null</jk>.
+ * @param childPojoSwap
+ * The child {@link PojoSwap PojoSwaps} programmatically associated with this class.
+ * These are the <code>PojoSwaps</code> that have normal classes that are subclasses of this class.
+ * Can be <jk>null</jk>.
+ * @param delayedInit
+ * Don't call init() in constructor.
+ * Used for delayed initialization when the possibility of class reference loops exist.
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
ClassMeta(Class<T> innerClass, BeanContext beanContext, Class<? extends T> implClass, BeanFilter beanFilter, PojoSwap<T,?> pojoSwap, PojoSwap<?,?>[] childPojoSwaps) {
@@ -196,6 +202,8 @@ public final class ClassMeta<T> implements Type {
/**
* Copy constructor.
+ *
+ * <p>
* Used for creating Map and Collection class metas that shouldn't be cached.
*/
ClassMeta(ClassMeta<T> mainType, ClassMeta<?> keyType, ClassMeta<?> valueType, ClassMeta<?> elementType) {
@@ -684,11 +692,13 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the type property name associated with this class and subclasses.
+ *
* <p>
* If <jk>null</jk>, <js>"_type"</js> should be assumed.
*
- * @return The type property name associated with this bean class, or <jk>null</jk> if there is no explicit type
- * property name defined or this isn't a bean.
+ * @return
+ * The type property name associated with this bean class, or <jk>null</jk> if there is no explicit type
+ * property name defined or this isn't a bean.
*/
public String getBeanTypePropertyName() {
return typePropertyName;
@@ -696,11 +706,13 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the bean dictionary name associated with this class.
+ *
* <p>
* The lexical name is defined by {@link Bean#typeName()}.
*
- * @return The type name associated with this bean class, or <jk>null</jk> if there is no type name defined or this
- * isn't a bean.
+ * @return
+ * The type name associated with this bean class, or <jk>null</jk> if there is no type name defined or this
+ * isn't a bean.
*/
public String getDictionaryName() {
return dictionaryName;
@@ -708,9 +720,10 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the bean registry for this class.
+ *
* <p>
- * This bean registry contains names specified in the {@link Bean#beanDictionary()} annotation defined
- * on the class, regardless of whether the class is an actual bean.
+ * This bean registry contains names specified in the {@link Bean#beanDictionary()} annotation defined on the class,
+ * regardless of whether the class is an actual bean.
* This allows interfaces to define subclasses with type names.
*
* @return The bean registry for this class, or <jk>null</jk> if no bean registry is associated with it.
@@ -750,9 +763,10 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class or any child classes has a {@link PojoSwap} associated with it.
+ *
* <p>
- * Used when transforming bean properties to prevent having to look up transforms if we know for certain
- * that no transforms are associated with a bean property.
+ * Used when transforming bean properties to prevent having to look up transforms if we know for certain that no
+ * transforms are associated with a bean property.
*
* @return <jk>true</jk> if this class or any child classes has a {@link PojoSwap} associated with it.
*/
@@ -761,8 +775,8 @@ public final class ClassMeta<T> implements Type {
}
/**
- * Returns the {@link PojoSwap} where the specified class is the same/subclass of the normal class of
- * one of the child POJO swaps associated with this class.
+ * Returns the {@link PojoSwap} where the specified class is the same/subclass of the normal class of one of the
+ * child POJO swaps associated with this class.
*
* @param normalClass The normal class being resolved.
* @return The resolved {@link PojoSwap} or <jk>null</jk> if none were found.
@@ -788,8 +802,8 @@ public final class ClassMeta<T> implements Type {
}
/**
- * Returns the {@link PojoSwap} where the specified class is the same/subclass of the swap class of
- * one of the child POJO swaps associated with this class.
+ * Returns the {@link PojoSwap} where the specified class is the same/subclass of the swap class of one of the child
+ * POJO swaps associated with this class.
*
* @param swapClass The swap class being resolved.
* @return The resolved {@link PojoSwap} or <jk>null</jk> if none were found.
@@ -816,6 +830,8 @@ public final class ClassMeta<T> implements Type {
/**
* Locates the no-arg constructor for the specified class.
+ *
+ * <p>
* Constructor must match the visibility requirements specified by parameter 'v'.
* If class is abstract, always returns <jk>null</jk>.
* Note that this also returns the 1-arg constructor for non-static member classes.
@@ -886,8 +902,8 @@ public final class ClassMeta<T> implements Type {
}
/**
- * Returns <jk>true</jk> if this class implements {@link Delegate}, meaning
- * it's a representation of some other object.
+ * Returns <jk>true</jk> if this class implements {@link Delegate}, meaning it's a representation of some other
+ * object.
*
* @return <jk>true</jk> if this class implements {@link Delegate}.
*/
@@ -1144,9 +1160,10 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if instance of this object can be <jk>null</jk>.
+ *
* <p>
- * Objects can be <jk>null</jk>, but primitives cannot, except for chars which can be represented
- * by <code>(<jk>char</jk>)0</code>.
+ * Objects can be <jk>null</jk>, but primitives cannot, except for chars which can be represented by
+ * <code>(<jk>char</jk>)0</code>.
*
* @return <jk>true</jk> if instance of this class can be null.
*/
@@ -1167,6 +1184,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is abstract.
+ *
* @return <jk>true</jk> if this class is abstract.
*/
public boolean isAbstract() {
@@ -1175,6 +1193,7 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class is an inner class.
+ *
* @return <jk>true</jk> if this class is an inner class.
*/
public boolean isMemberClass() {
@@ -1184,6 +1203,8 @@ public final class ClassMeta<T> implements Type {
/**
* All methods on this class annotated with {@link Remoteable @Remotable}, or all public methods if class is
* annotated.
+ *
+ * <p>
* Keys are method signatures.
*
* @return All remoteable methods on this class.
@@ -1194,6 +1215,8 @@ public final class ClassMeta<T> implements Type {
/**
* All public methods on this class including static methods.
+ *
+ * <p>
* Keys are method signatures.
*
* @return The public methods on this class.
@@ -1205,8 +1228,9 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the {@link PojoSwap} associated with this class.
*
- * @return The {@link PojoSwap} associated with this class, or <jk>null</jk> if there is no POJO swap
- * associated with this class.
+ * @return
+ * The {@link PojoSwap} associated with this class, or <jk>null</jk> if there is no POJO swap associated with
+ * this class.
*/
public PojoSwap<T,?> getPojoSwap() {
return pojoSwap;
@@ -1215,8 +1239,9 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the {@link BeanMeta} associated with this class.
*
- * @return The {@link BeanMeta} associated with this class, or <jk>null</jk> if there is no bean meta
- * associated with this class.
+ * @return
+ * The {@link BeanMeta} associated with this class, or <jk>null</jk> if there is no bean meta associated with
+ * this class.
*/
public BeanMeta<T> getBeanMeta() {
return beanMeta;
@@ -1269,13 +1294,13 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class has a no-arg constructor or invocation handler.
- * Returns <jk>false</jk> if this is a non-static member class and the outer object does not match
- * the class type of the defining class.
+ * Returns <jk>false</jk> if this is a non-static member class and the outer object does not match the class type of
+ * the defining class.
*
- * @param outer The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static
- * classes.
- * @return <jk>true</jk> if a new instance of this class can be created within the context of the specified outer
- * object.
+ * @param outer
+ * The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static classes.
+ * @return
+ * <jk>true</jk> if a new instance of this class can be created within the context of the specified outer object.
*/
public boolean canCreateNewInstance(Object outer) {
if (isMemberClass)
@@ -1285,13 +1310,13 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class can be instantiated as a bean.
- * Returns <jk>false</jk> if this is a non-static member class and the outer object does not match
- * the class type of the defining class.
+ * Returns <jk>false</jk> if this is a non-static member class and the outer object does not match the class type of
+ * the defining class.
*
- * @param outer The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static
- * classes.
- * @return <jk>true</jk> if a new instance of this bean can be created within the context of the specified outer
- * object.
+ * @param outer
+ * The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static classes.
+ * @return
+ * <jk>true</jk> if a new instance of this bean can be created within the context of the specified outer object.
*/
public boolean canCreateNewBean(Object outer) {
if (beanMeta == null)
@@ -1306,8 +1331,9 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class can call the {@link #newInstanceFromString(Object, String)} method.
*
- * @param outer The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static
- * classes.
+ * @param outer
+ * The outer class object for non-static member classes.
+ * Can be <jk>null</jk> for non-member or static classes.
* @return <jk>true</jk> if this class has a no-arg constructor or invocation handler.
*/
public boolean canCreateNewInstanceFromString(Object outer) {
@@ -1324,8 +1350,9 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if this class can call the {@link #newInstanceFromString(Object, String)} method.
*
- * @param outer The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static
- * classes.
+ * @param outer
+ * The outer class object for non-static member classes.
+ * Can be <jk>null</jk> for non-member or static classes.
* @return <jk>true</jk> if this class has a no-arg constructor or invocation handler.
*/
public boolean canCreateNewInstanceFromNumber(Object outer) {
@@ -1350,18 +1377,20 @@ public final class ClassMeta<T> implements Type {
/**
* Returns the method or field annotated with {@link NameProperty @NameProperty}.
*
- * @return The method or field annotated with {@link NameProperty @NameProperty} or <jk>null</jk> if method does
- * not exist.
+ * @return
+ * The method or field annotated with {@link NameProperty @NameProperty} or <jk>null</jk> if method does not
+ * exist.
*/
public Setter getNameProperty() {
return namePropertyMethod;
}
/**
- * Returns the method or field annotated with {@link ParentProperty @ParentProperty}.
+ * Returns the method or field annotated with {@link ParentProperty @ParentProperty}.
*
- * @return The method or field annotated with {@link ParentProperty @ParentProperty} or <jk>null</jk> if method
- * does not exist.
+ * @return
+ * The method or field annotated with {@link ParentProperty @ParentProperty} or <jk>null</jk> if method does not
+ * exist.
*/
public Setter getParentProperty() {
return parentPropertyMethod;
@@ -1406,6 +1435,7 @@ public final class ClassMeta<T> implements Type {
/**
* Create a new instance of the main class of this declared type from a <code>String</code> input.
+ *
* <p>
* In order to use this method, the class must have one of the following methods:
* <ul>
@@ -1414,15 +1444,17 @@ public final class ClassMeta<T> implements Type {
* <li><code><jk>public</jk> T(String in);</code>
* </ul>
*
- * @param outer The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static
- * classes.
+ * @param outer
+ * The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static classes.
* @param arg The input argument value.
* @return A new instance of the object, or <jk>null</jk> if there is no string constructor on the object.
- * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and
- * the underlying constructor is inaccessible.
+ * @throws IllegalAccessException
+ * If the <code>Constructor</code> object enforces Java language access control and the underlying constructor is
+ * inaccessible.
* @throws IllegalArgumentException If the parameter type on the method was invalid.
- * @throws InstantiationException If the class that declares the underlying constructor represents an abstract class, or
- * does not have one of the methods described above.
+ * @throws InstantiationException
+ * If the class that declares the underlying constructor represents an abstract class, or does not have one of
+ * the methods described above.
* @throws InvocationTargetException If the underlying constructor throws an exception.
*/
@SuppressWarnings("unchecked")
@@ -1441,6 +1473,7 @@ public final class ClassMeta<T> implements Type {
/**
* Create a new instance of the main class of this declared type from a <code>Number</code> input.
+ *
* <p>
* In order to use this method, the class must have one of the following methods:
* <ul>
@@ -1448,15 +1481,18 @@ public final class ClassMeta<T> implements Type {
* </ul>
*
* @param session The current bean session.
- * @param outer The outer class object for non-static member classes. Can be <jk>null</jk> for non-member or static
- * classes.
+ * @param outer
+ * The outer class object for non-static member classes.
+ * Can be <jk>null</jk> for non-member or static classes.
* @param arg The input argument value.
* @return A new instance of the object, or <jk>null</jk> if there is no numeric constructor on the object.
- * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and
- * the underlying constructor is inaccessible.
+ * @throws IllegalAccessException
+ * If the <code>Constructor</code> object enforces Java language access control and the underlying constructor is
+ * inaccessible.
* @throws IllegalArgumentException If the parameter type on the method was invalid.
- * @throws InstantiationException If the class that declares the underlying constructor represents an abstract
- * class, or does not have one of the methods described above.
+ * @throws InstantiationException
+ * If the class that declares the underlying constructor represents an abstract class, or does not have one of
+ * the methods described above.
* @throws InvocationTargetException If the underlying constructor throws an exception.
*/
public T newInstanceFromNumber(BeanSession session, Object outer, Number arg) throws IllegalArgumentException, IllegalAccessException, InvocationTargetException, InstantiationException {
@@ -1474,9 +1510,11 @@ public final class ClassMeta<T> implements Type {
* Create a new instance of the main class of this declared type.
*
* @return A new instance of the object, or <jk>null</jk> if there is no no-arg constructor on the object.
- * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and
- * the underlying constructor is inaccessible.
- * @throws IllegalArgumentException If one of the following occurs:
+ * @throws IllegalAccessException
+ * If the <code>Constructor</code> object enforces Java language access control and the underlying constructor is
+ * inaccessible.
+ * @throws IllegalArgumentException
+ * If one of the following occurs:
* <ul class='spaced-list'>
* <li>
* The number of actual and formal parameters differ.
@@ -1509,12 +1547,15 @@ public final class ClassMeta<T> implements Type {
/**
* Same as {@link #newInstance()} except for instantiating non-static member classes.
*
- * @param outer The instance of the owning object of the member class instance. Can be <jk>null</jk> if
- * instantiating a non-member or static class.
+ * @param outer
+ * The instance of the owning object of the member class instance.
+ * Can be <jk>null</jk> if instantiating a non-member or static class.
* @return A new instance of the object, or <jk>null</jk> if there is no no-arg constructor on the object.
- * @throws IllegalAccessException If the <code>Constructor</code> object enforces Java language access control and
- * the underlying constructor is inaccessible.
- * @throws IllegalArgumentException If one of the following occurs:
+ * @throws IllegalAccessException
+ * If the <code>Constructor</code> object enforces Java language access control and the underlying constructor is
+ * inaccessible.
+ * @throws IllegalArgumentException
+ * If one of the following occurs:
* <ul class='spaced-list'>
* <li>
* The number of actual and formal parameters differ.
@@ -1550,8 +1591,8 @@ public final class ClassMeta<T> implements Type {
}
/**
- * Similar to {@link #equals(Object)} except primitive and Object types that are similar
- * are considered the same. (e.g. <jk>boolean</jk> == <code>Boolean</code>).
+ * Similar to {@link #equals(Object)} except primitive and Object types that are similar are considered the same.
+ * (e.g. <jk>boolean</jk> == <code>Boolean</code>).
*
* @param cm The class meta to compare to.
* @return <jk>true</jk> if the specified class-meta is equivalent to this one.
@@ -1611,8 +1652,9 @@ public final class ClassMeta<T> implements Type {
/**
* Returns <jk>true</jk> if the specified object is an instance of this class.
- * This is a simple comparison on the base class itself and not on
- * any generic parameters.
+ *
+ * <p>
+ * This is a simple comparison on the base class itself and not on any generic parameters.
*
* @param o The object to check.
* @return <jk>true</jk> if the specified object is an instance of this class.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/ClassMetaExtended.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/ClassMetaExtended.java b/juneau-core/src/main/java/org/apache/juneau/ClassMetaExtended.java
index 3de3147..b085de1 100644
--- a/juneau-core/src/main/java/org/apache/juneau/ClassMetaExtended.java
+++ b/juneau-core/src/main/java/org/apache/juneau/ClassMetaExtended.java
@@ -14,9 +14,10 @@ package org.apache.juneau;
/**
* Defines extended language-specific metadata associated with a class.
+ *
* <p>
- * Serializers and parsers can implement their own language-specific metadata on a class and retrieve
- * the metadata using the {@link ClassMeta#getExtendedMeta(Class)} method.
+ * Serializers and parsers can implement their own language-specific metadata on a class and retrieve the metadata
+ * using the {@link ClassMeta#getExtendedMeta(Class)} method.
*/
public class ClassMetaExtended {
@@ -24,6 +25,7 @@ public class ClassMetaExtended {
/**
* Constructor.
+ *
* @param cm The metadata of the class we're extending.
* @throws BeanRuntimeException If any error occurred trying to construct the metadata.
*/
@@ -33,6 +35,7 @@ public class ClassMetaExtended {
/**
* Returns the class metadata that was passed into the constructor.
+ *
* @return The class metadata that was passed into the constructor.
*/
protected ClassMeta<?> getClassMeta() {
@@ -41,6 +44,7 @@ public class ClassMetaExtended {
/**
* Convenience method for calling {@link ClassMeta#getInnerClass()} on the metadata passed to the constructor.
+ *
* @return The class wrapped by this metadata.
*/
protected Class<?> getInnerClass() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/Context.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/Context.java b/juneau-core/src/main/java/org/apache/juneau/Context.java
index df8bf27..820dfc2 100644
--- a/juneau-core/src/main/java/org/apache/juneau/Context.java
+++ b/juneau-core/src/main/java/org/apache/juneau/Context.java
@@ -19,12 +19,14 @@ import org.apache.juneau.serializer.*;
/**
* A reusable stateless thread-safe read-only configuration, typically used for creating one-time use {@link Session}
* objects.
+ *
* <p>
* Contexts are created through the {@link PropertyStore#getContext(Class)} method.
+ *
* <p>
* Subclasses MUST implement a constructor method that takes in a {@link PropertyStore} parameter.
- * Besides that restriction, a context object can do anything you desire. However, it MUST
- * be thread-safe and all fields should be declared final to prevent modification.
+ * Besides that restriction, a context object can do anything you desire.
+ * However, it MUST be thread-safe and all fields should be declared final to prevent modification.
* It should NOT be used for storing temporary or state information.
*
* @see PropertyStore
@@ -35,6 +37,7 @@ public abstract class Context {
/**
* Constructor for this class.
+ *
* <p>
* Subclasses MUST implement the same constructor.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/CoreObject.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/CoreObject.java b/juneau-core/src/main/java/org/apache/juneau/CoreObject.java
index 1d6fdce..de19fde 100644
--- a/juneau-core/src/main/java/org/apache/juneau/CoreObject.java
+++ b/juneau-core/src/main/java/org/apache/juneau/CoreObject.java
@@ -24,6 +24,7 @@ public abstract class CoreObject {
/**
* Constructor.
+ *
* @param propertyStore The property store containing all the settings for this object.
*/
protected CoreObject(PropertyStore propertyStore) {
@@ -32,8 +33,8 @@ public abstract class CoreObject {
}
/**
- * Creates a new builder class for this object so that a new object can be created
- * that expands upon the current object's settings.
+ * Creates a new builder class for this object so that a new object can be created that expands upon the current
+ * object's settings.
*
* @return A new builder.
*/
@@ -42,11 +43,11 @@ public abstract class CoreObject {
}
/**
- * Method used by subclasses to override context factory properties for just this
- * instance without modifying the context factory itself.
+ * Method used by subclasses to override context factory properties for just this instance without modifying the
+ * context factory itself.
+ *
* <p>
- * Subclasses can call this parent method to append to override properties defined
- * higher in the parent chain.
+ * Subclasses can call this parent method to append to override properties defined higher in the parent chain.
*
* @return The override properties. Never <jk>null</jk>.
*/
@@ -55,19 +56,19 @@ public abstract class CoreObject {
}
/**
- * Returns a copy of the context factory passed in to the constructor with
- * any override properties applied from the {@link #getOverrideProperties()}.
+ * Returns a copy of the context factory passed in to the constructor with any override properties applied from the
+ * {@link #getOverrideProperties()}.
*
- * @return The context factory on this class.
- * Multiple calls to this method returns the same factory.
+ * @return
+ * The context factory on this class.
+ * Multiple calls to this method returns the same factory.
*/
public PropertyStore createPropertyStore() {
return PropertyStore.create(propertyStore);
}
/**
- * Creates a read-only context object of the specified type using the context
- * factory on this class.
+ * Creates a read-only context object of the specified type using the context factory on this class.
*
* @param c The context class to create.
* @return The new context object.
@@ -78,6 +79,7 @@ public abstract class CoreObject {
/**
* Returns the bean context to use for this class.
+ *
* @return The bean context object.
*/
public BeanContext getBeanContext() {