juneau-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jamesbog...@apache.org
Subject [juneau] branch master updated: Javadocs
Date Sun, 12 Aug 2018 16:41:22 GMT
This is an automated email from the ASF dual-hosted git repository.

jamesbognar pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/juneau.git


The following commit(s) were added to refs/heads/master by this push:
     new 00f9c89  Javadocs
00f9c89 is described below

commit 00f9c898666b141d57c239cc65e4615cd14fc934
Author: JamesBognar <jamesbognar@apache.org>
AuthorDate: Sun Aug 12 12:41:06 2018 -0400

    Javadocs
---
 .../apache/juneau/dto/jsonschema/JsonSchema.java   |   6 +-
 .../java/org/apache/juneau/dto/swagger/Info.java   |   5 +-
 .../java/org/apache/juneau/dto/swagger/Items.java  |   5 +-
 .../org/apache/juneau/jena/annotation/Rdf.java     |   2 +-
 .../main/java/org/apache/juneau/BeanSession.java   |   4 +-
 .../main/java/org/apache/juneau/ObjectList.java    |   4 +-
 .../src/main/java/org/apache/juneau/ObjectMap.java |   4 +-
 .../main/java/org/apache/juneau/UriResolution.java |   8 +-
 .../apache/juneau/encoders/IdentityEncoder.java    |   5 +-
 .../httppart/bean/RequestBeanPropertyMeta.java     |   4 +-
 .../httppart/bean/ResponseBeanPropertyMeta.java    |   4 +-
 .../java/org/apache/juneau/internal/DateUtils.java |   5 +-
 .../org/apache/juneau/internal/FilteredMap.java    |   2 +-
 .../org/apache/juneau/parser/ParserReader.java     |   2 +-
 .../org/apache/juneau/parser/ParserSession.java    |   5 +-
 .../org/apache/juneau/parser/Positionable.java     |   2 +-
 .../apache/juneau/uon/UonSerializerSession.java    |   6 +-
 .../org/apache/juneau/utils/PojoIntrospector.java  |   5 +-
 .../apache/juneau/xml/annotation/XmlFormat.java    |   2 +-
 juneau-doc/src/main/javadoc/overview.html          | 106 ++++++++++++---------
 .../Topics/02.juneau-marshall/16.URIs.html         |   5 +-
 .../Topics/07.juneau-rest-server/18.URIs.html      | 103 +++++++++++---------
 .../juneau/rest/helper/ResourceDescription.java    |   5 +-
 23 files changed, 181 insertions(+), 118 deletions(-)

diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/JsonSchema.java
b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/JsonSchema.java
index 4ddd0f5..acfac6e 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/JsonSchema.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/jsonschema/JsonSchema.java
@@ -1450,8 +1450,12 @@ public class JsonSchema {
 		if (not != null)
 			not.setMaster(master);
 	}
+
 	/**
-	 * If this schema is a reference to another schema (i.e. has its <property>$ref</property>
property set), this
+	 * Resolve schema if reference.
+	 *
+	 * <p>
+	 * If this schema is a reference to another schema (has its <property>$ref</property>
property set), this
 	 * method will retrieve the referenced schema from the schema map registered with this schema.
 	 *
 	 * <p>
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Info.java
b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Info.java
index 530bdb7..436873b 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Info.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Info.java
@@ -22,7 +22,10 @@ import org.apache.juneau.internal.*;
 import org.apache.juneau.utils.*;
 
 /**
- * The object provides metadata about the API. The metadata can be used by the clients if
needed, and can be presented
+ * The object provides metadata about the API.
+ *
+ * <p>
+ * The metadata can be used by the clients if needed, and can be presented
  * in the Swagger-UI for convenience.
  *
  * <h5 class='section'>Example:</h5>
diff --git a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Items.java
b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Items.java
index b5711ec..15de547 100644
--- a/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Items.java
+++ b/juneau-core/juneau-dto/src/main/java/org/apache/juneau/dto/swagger/Items.java
@@ -24,7 +24,10 @@ import org.apache.juneau.json.*;
 import org.apache.juneau.utils.*;
 
 /**
- * A limited subset of JSON-Schema's items object. It is used by parameter definitions that
are not located in "body".
+ * A limited subset of JSON-Schema's items object.
+ *
+ * <p>
+ * It is used by parameter definitions that are not located in "body".
  *
  * <h5 class='section'>Example:</h5>
  * <p class='bcode w800'>
diff --git a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/annotation/Rdf.java
b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/annotation/Rdf.java
index 6cadda8..eeb5e75 100644
--- a/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/annotation/Rdf.java
+++ b/juneau-core/juneau-marshall-rdf/src/main/java/org/apache/juneau/jena/annotation/Rdf.java
@@ -51,7 +51,7 @@ public @interface Rdf {
 	boolean beanUri() default false;
 
 	/**
-	 * The format for how collections (e.g. lists and arrays) are serialized in RDF.
+	 * The format for how collections (lists and arrays for example) are serialized in RDF.
 	 *
 	 * @see RdfCollectionFormat
 	 */
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanSession.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanSession.java
index ff363c5..04acae0 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/BeanSession.java
@@ -745,7 +745,7 @@ public class BeanSession extends Session {
 	}
 
 	/**
-	 * Wraps an object inside a {@link BeanMap} object (i.e. a modifiable {@link Map}).
+	 * Wraps an object inside a {@link BeanMap} object (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
@@ -829,7 +829,7 @@ public class BeanSession extends Session {
 	}
 
 	/**
-	 * Creates a new {@link BeanMap} object (i.e. a modifiable {@link Map}) of the given class
with uninitialized
+	 * Creates a new {@link BeanMap} object (a modifiable {@link Map}) of the given class with
uninitialized
 	 * property values.
 	 *
 	 * <p>
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ObjectList.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ObjectList.java
index 23bf7b4..a5e9f00 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ObjectList.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ObjectList.java
@@ -194,13 +194,13 @@ public class ObjectList extends LinkedList<Object> {
 	}
 
 	/**
-	 * Construct an empty JSON array. (i.e. an empty {@link LinkedList}).
+	 * Construct an empty JSON array (an empty {@link LinkedList}).
 	 */
 	public ObjectList() {
 	}
 
 	/**
-	 * Construct an empty JSON array with the specified bean context. (i.e. an empty {@link
LinkedList}).
+	 * Construct an empty JSON array (an empty {@link LinkedList}) with the specified bean context.
 	 *
 	 * @param session The bean context to associate with this object list for creating beans.
 	 */
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ObjectMap.java b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ObjectMap.java
index 01e6336..0f5d0d6 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ObjectMap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ObjectMap.java
@@ -197,13 +197,13 @@ public class ObjectMap extends LinkedHashMap<String,Object> {
 	}
 
 	/**
-	 * Construct an empty JSON object (i.e. an empty {@link LinkedHashMap}).
+	 * Construct an empty JSON object (an empty {@link LinkedHashMap}).
 	 */
 	public ObjectMap() {
 	}
 
 	/**
-	 * Construct an empty JSON object (i.e. an empty {@link LinkedHashMap}) with the specified
bean context.
+	 * Construct an empty JSON object (an empty {@link LinkedHashMap}) with the specified bean
context.
 	 *
 	 * @param session The bean session to use for creating beans.
 	 */
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/UriResolution.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/UriResolution.java
index aacfe6d..cbe846e 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/UriResolution.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/UriResolution.java
@@ -18,12 +18,16 @@ package org.apache.juneau;
 public enum UriResolution {
 
 	/**
-	 * Resolve to an absolute URL (e.g. <js>"http://host:port/context-root/servlet-path/path-info"</js>).
+	 * Resolve to an absolute URL.
+	 * <p>
+	 * (e.g. <js>"http://host:port/context-root/servlet-path/path-info"</js>)
 	 */
 	ABSOLUTE,
 
 	/**
-	 * Resolve to a root-relative URL (e.g. <js>"/context-root/servlet-path/path-info"</js>).
+	 * Resolve to a root-relative URL.
+	 * <p>
+	 * (e.g. <js>"/context-root/servlet-path/path-info"</js>)
 	 */
 	ROOT_RELATIVE,
 
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/IdentityEncoder.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/IdentityEncoder.java
index 763764b..7682305 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/IdentityEncoder.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/encoders/IdentityEncoder.java
@@ -15,7 +15,10 @@ package org.apache.juneau.encoders;
 import java.io.*;
 
 /**
- * Encoder for handling <js>"identity"</js> encoding and decoding (e.g. no encoding
at all).
+ * Encoder for handling <js>"identity"</js> encoding and decoding.
+ *
+ * <p>
+ * Identity encoding is just another name for no encoding at all.
  */
 public class IdentityEncoder extends Encoder {
 
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/bean/RequestBeanPropertyMeta.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/bean/RequestBeanPropertyMeta.java
index ebdbc86..62953ce 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/bean/RequestBeanPropertyMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/bean/RequestBeanPropertyMeta.java
@@ -82,7 +82,7 @@ public class RequestBeanPropertyMeta {
 	}
 
 	/**
-	 * Returns the HTTP part name for this property (e.g. query parameter name).
+	 * Returns the HTTP part name for this property (query parameter name for example).
 	 *
 	 * @return The HTTP part name, or <jk>null</jk> if it doesn't have a part name.
 	 */
@@ -102,7 +102,7 @@ public class RequestBeanPropertyMeta {
 	}
 
 	/**
-	 * Returns the HTTP part type for this property (e.g. query parameter, header, etc...).
+	 * Returns the HTTP part type for this property (query parameter for example).
 	 *
 	 * @return
 	 * 	The HTTP part type for this property.
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/bean/ResponseBeanPropertyMeta.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/bean/ResponseBeanPropertyMeta.java
index fbf667a..d4b6553 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/bean/ResponseBeanPropertyMeta.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/httppart/bean/ResponseBeanPropertyMeta.java
@@ -84,7 +84,7 @@ public class ResponseBeanPropertyMeta {
 	}
 
 	/**
-	 * Returns the HTTP part name for this property (e.g. query parameter name).
+	 * Returns the HTTP part name for this property (the query parameter name for example).
 	 *
 	 * @return The HTTP part name, or <jk>null</jk> if it doesn't have a part name.
 	 */
@@ -104,7 +104,7 @@ public class ResponseBeanPropertyMeta {
 	}
 
 	/**
-	 * Returns the HTTP part type for this property (e.g. query parameter, header, etc...).
+	 * Returns the HTTP part type for this property (query parameter for example).
 	 *
 	 * @return
 	 * 	The HTTP part type for this property.
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DateUtils.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DateUtils.java
index 49e2a94..e052602 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DateUtils.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/DateUtils.java
@@ -57,7 +57,10 @@ public final class DateUtils {
 	}
 
 	/**
-	 * Parses a date value. The formats used for parsing the date value are retrieved from the
default http params.
+	 * Parses a date value.
+	 *
+	 * <p>
+	 * The formats used for parsing the date value are retrieved from the default http params.
 	 *
 	 * @param dateValue the date value to parse
 	 * @return the parsed date or null if input could not be parsed
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/FilteredMap.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/FilteredMap.java
index 516e698..f0845e1 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/FilteredMap.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/internal/FilteredMap.java
@@ -77,7 +77,7 @@ public final class FilteredMap<K,V> extends AbstractMap<K,V>
implements Delegate
 	}
 
 	/**
-	 * A set with ordered entries (i.e. a List with a Set API).
+	 * A set with ordered entries (a List with a Set API).
 	 */
 	private static final class ListSet<E> extends AbstractSet<E> {
 
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserReader.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserReader.java
index 4837f5d..dcdb7dd 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserReader.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserReader.java
@@ -106,7 +106,7 @@ public class ParserReader extends Reader implements Positionable {
 	}
 
 	/**
-	 * Same as {@link #read()} but detects and combines extended unicode characters (i.e. characters
above 0x10000).
+	 * Same as {@link #read()} but detects and combines extended unicode characters (characters
above 0x10000).
 	 *
 	 * @return The character read, or -1 if the end of the stream has been reached.
 	 * @throws IOException If a problem occurred trying to read from the reader.
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserSession.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserSession.java
index b1f9cb0..0908c84 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/ParserSession.java
@@ -89,7 +89,10 @@ public abstract class ParserSession extends BeanSession {
 	//--------------------------------------------------------------------------------
 
 	/**
-	 * Workhorse method.  Subclasses are expected to implement this method.
+	 * Workhorse method.
+	 *
+	 * <p>
+	 * Subclasses are expected to implement this method.
 	 *
 	 * @param pipe Where to get the input from.
 	 * @param type
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/Positionable.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/Positionable.java
index 3b67208..bc64954 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/Positionable.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/parser/Positionable.java
@@ -13,7 +13,7 @@
 package org.apache.juneau.parser;
 
 /**
- * Interface for objects with positions (e.g. lines/columns/byte-positions).
+ * Interface for objects with positions (lines/columns/byte-positions for example).
  */
 public interface Positionable {
 
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonSerializerSession.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonSerializerSession.java
index b1670b0..542883f 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonSerializerSession.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/uon/UonSerializerSession.java
@@ -77,8 +77,10 @@ public class UonSerializerSession extends WriterSerializerSession {
 	}
 
 	/**
-	 * Workhorse method. Determines the type of object, and then calls the appropriate type-specific
serialization
-	 * method.
+	 * Workhorse method.
+	 *
+	 * <p>
+	 * Determines the type of object, and then calls the appropriate type-specific serialization
method.
 	 *
 	 * @param out The writer to serialize to.
 	 * @param o The object being serialized.
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoIntrospector.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoIntrospector.java
index 4fece1a..c036f71 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoIntrospector.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/utils/PojoIntrospector.java
@@ -58,7 +58,10 @@ public final class PojoIntrospector {
 	}
 
 	/**
-	 * Primary method.  Invokes the specified method on this bean.
+	 * Primary method.
+	 *
+	 * <p>
+	 * Invokes the specified method on this bean.
 	 *
 	 * @param method The method being invoked.
 	 * @param args
diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlFormat.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlFormat.java
index f536b7c..4ea6a8f 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlFormat.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/xml/annotation/XmlFormat.java
@@ -81,7 +81,7 @@ public enum XmlFormat {
 	ELEMENTS,
 
 	/**
-	 * Same as {@link #ELEMENTS} except primitive types (e.g. string/boolean/number/null) are
not wrapped in elements.
+	 * Same as {@link #ELEMENTS} except primitive types (string/boolean/number/null for example)
are not wrapped in elements.
 	 *
 	 * <p>
 	 * Only applicable for bean properties, not bean classes.
diff --git a/juneau-doc/src/main/javadoc/overview.html b/juneau-doc/src/main/javadoc/overview.html
index a00d2ca..9a86757 100644
--- a/juneau-doc/src/main/javadoc/overview.html
+++ b/juneau-doc/src/main/javadoc/overview.html
@@ -3793,8 +3793,7 @@
 			<jf>f4a</jf> = URI.<jsm>create</jsm>(<js>"request:/f4a/x"</js>),
 			<jf>f4b</jf> = URI.<jsm>create</jsm>(<js>"request:/f4b"</js>),
 			<jf>f4c</jf> = URI.<jsm>create</jsm>(<js>"request:/"</js>),
-			<jf>f4d</jf> = URI.<jsm>create</jsm>(<js>"request:/.."</js>),
-			<jf>f5 </jf> = <jk>null</jk>;
+			<jf>f4d</jf> = URI.<jsm>create</jsm>(<js>"request:/.."</js>);;
 	}	
 	
 	<jc>// Create a serializer.</jc>
@@ -3825,7 +3824,7 @@
 	<jc>//	f4a:'http://foo.com:123/myContext/myServlet/myPath/f4a/x',</jc>
 	<jc>//	f4b:'http://foo.com:123/myContext/myServlet/myPath/f4b',</jc>
 	<jc>//	f4c:'http://foo.com:123/myContext/myServlet/myPath',</jc>
-	<jc>//	f4d:'http://foo.com:123/myContext/myServlet',</jc>
+	<jc>//	f4d:'http://foo.com:123/myContext/myServlet'</jc>
 	<jc>// }</jc>
 	String json = s.serialize(<jk>new</jk> TestURIs());
 </p>
@@ -16700,31 +16699,34 @@ TODO(7.2.0)
 </p>
 <p class='bpcode w800'>
 	<ja>@RestResource</ja>(
+		uriAuthority=<js>"http://foo.com:123"</js>,
+		uriContext=<js>"/myContext"</js>
 	)
-		
-	<ja>@RestMethod</ja>
-	<jk>public</jk> URI[] getURIs() {
-		<jk>return new</jk> URI[] {
-			URI.<jsm>create</jsm>(<js>"http://www.apache.org/f1a"</js>),
-			URI.<jsm>create</jsm>(<js>"/f1b"</js>),
-			URI.<jsm>create</jsm>(<js>"/f1c/x/y"</js>),
-			URI.<jsm>create</jsm>(<js>"f1d"</js>),
-			URI.<jsm>create</jsm>(<js>"f1e/x/y"</js>),
-			URI.<jsm>create</jsm>(<js>""</js>),
-			URI.<jsm>create</jsm>(<js>"context:/f2a/x"</js>),
-			URI.<jsm>create</jsm>(<js>"context:/f2b"</js>),
-			URI.<jsm>create</jsm>(<js>"context:/"</js>),
-			URI.<jsm>create</jsm>(<js>"context:/.."</js>),
-			URI.<jsm>create</jsm>(<js>"servlet:/f3a/x"</js>),
-			URI.<jsm>create</jsm>(<js>"servlet:/f3b"</js>),
-			URI.<jsm>create</jsm>(<js>"servlet:/"</js>),
-			URI.<jsm>create</jsm>(<js>"servlet:/.."</js>),
-			URI.<jsm>create</jsm>(<js>"request:/f4a/x"</js>),
-			URI.<jsm>create</jsm>(<js>"request:/f4b"</js>),
-			URI.<jsm>create</jsm>(<js>"request:/"</js>),
-			URI.<jsm>create</jsm>(<js>"request:/.."</js>),
-			<jk>null</jk>
-		};
+	<jk>public class</jk> MyResource {
+	
+		<ja>@RestMethod</ja>
+		<jk>public</jk> URI[] getURIs() {
+			<jk>return new</jk> URI[] {
+				URI.<jsm>create</jsm>(<js>"http://www.apache.org/f1a"</js>),
+				URI.<jsm>create</jsm>(<js>"/f1b"</js>),
+				URI.<jsm>create</jsm>(<js>"/f1c/x/y"</js>),
+				URI.<jsm>create</jsm>(<js>"f1d"</js>),
+				URI.<jsm>create</jsm>(<js>"f1e/x/y"</js>),
+				URI.<jsm>create</jsm>(<js>""</js>),
+				URI.<jsm>create</jsm>(<js>"context:/f2a/x"</js>),
+				URI.<jsm>create</jsm>(<js>"context:/f2b"</js>),
+				URI.<jsm>create</jsm>(<js>"context:/"</js>),
+				URI.<jsm>create</jsm>(<js>"context:/.."</js>),
+				URI.<jsm>create</jsm>(<js>"servlet:/f3a/x"</js>),
+				URI.<jsm>create</jsm>(<js>"servlet:/f3b"</js>),
+				URI.<jsm>create</jsm>(<js>"servlet:/"</js>),
+				URI.<jsm>create</jsm>(<js>"servlet:/.."</js>),
+				URI.<jsm>create</jsm>(<js>"request:/f4a/x"</js>),
+				URI.<jsm>create</jsm>(<js>"request:/f4b"</js>),
+				URI.<jsm>create</jsm>(<js>"request:/"</js>),
+				URI.<jsm>create</jsm>(<js>"request:/.."</js>)
+			};
+		}
 	}	
 </p>
 <p>
@@ -16732,29 +16734,43 @@ TODO(7.2.0)
 </p>
 <p class='bpcode w800'>
 	{
-		f1a:'http://www.apache.org/f1a',
-		f1b:'http://foo.com:123/f1b',
-		f1c:'http://foo.com:123/f1c/x/y',
-		f1d:'http://foo.com:123/myContext/myServlet/f1d',
-		f1e:'http://foo.com:123/myContext/myServlet/f1e/x/y',
-		f1f:'http://foo.com:123/myContext/myServlet',
-		f2a:'http://foo.com:123/myContext/f2a/x',
-		f2b:'http://foo.com:123/myContext/f2b',
-		f2c:'http://foo.com:123/myContext',
-		f2d:'http://foo.com:123'
-		f3a:'http://foo.com:123/myContext/myServlet/f3a/x',
-		f3b:'http://foo.com:123/myContext/myServlet/f3b',
-		f3c:'http://foo.com:123/myContext/myServlet',
-		f3d:'http://foo.com:123/myContext',
-		f4a:'http://foo.com:123/myContext/myServlet/myPath/f4a/x',
-		f4b:'http://foo.com:123/myContext/myServlet/myPath/f4b',
-		f4c:'http://foo.com:123/myContext/myServlet/myPath',
-		f4d:'http://foo.com:123/myContext/myServlet',
+		<jok>f1a</jok>:<jov>'http://www.apache.org/f1a'</jov>,
+		<jok>f1b</jok>:<jov>'http://foo.com:123/f1b'</jov>,
+		<jok>f1c</jok>:<jov>'http://foo.com:123/f1c/x/y'</jov>,
+		<jok>f1d</jok>:<jov>'http://foo.com:123/myContext/myServlet/f1d'</jov>,
+		<jok>f1e</jok>:<jov>'http://foo.com:123/myContext/myServlet/f1e/x/y'</jov>,
+		<jok>f1f</jok>:<jov>'http://foo.com:123/myContext/myServlet'</jov>,
+		<jok>f2a</jok>:<jov>'http://foo.com:123/myContext/f2a/x'</jov>,
+		<jok>f2b</jok>:<jov>'http://foo.com:123/myContext/f2b'</jov>,
+		<jok>f2c</jok>:<jov>'http://foo.com:123/myContext'</jov>,
+		<jok>f2d</jok>:<jov>'http://foo.com:123'</jov>,
+		<jok>f3a</jok>:<jov>'http://foo.com:123/myContext/myServlet/f3a/x'</jov>,
+		<jok>f3b</jok>:<jov>'http://foo.com:123/myContext/myServlet/f3b'</jov>,
+		<jok>f3c</jok>:<jov>'http://foo.com:123/myContext/myServlet'</jov>,
+		<jok>f3d</jok>:<jov>'http://foo.com:123/myContext'</jov>,
+		<jok>f4a</jok>:<jov>'http://foo.com:123/myContext/myServlet/myPath/f4a/x'</jov>,
+		<jok>f4b</jok>:<jov>'http://foo.com:123/myContext/myServlet/myPath/f4b'</jov>,
+		<jok>f4c</jok>:<jov>'http://foo.com:123/myContext/myServlet/myPath'</jov>,
+		<jok>f4d</jok>:<jov>'http://foo.com:123/myContext/myServlet'</jov>
 	}
 </p>
 <p>
 	URI resolution is controlled by the following settings:
 </p>
+<ul class='doctree'>
+	<li class='jc'>{@link org.apache.juneau.rest.RestContext}
+	<ul>
+		<li class='jf'>{@link org.apache.juneau.rest.RestContext#REST_uriAuthority REST_uriAuthority}
+		<li class='jf'>{@link org.apache.juneau.rest.RestContext#REST_uriContext REST_uriContext}
+		<li class='jf'>{@link org.apache.juneau.rest.RestContext#REST_uriRelativity REST_uriRelativity}
+		<li class='jf'>{@link org.apache.juneau.rest.RestContext#REST_uriResolution REST_uriResolution}
+	</ul>	
+</ul>
+
+<p>
+	URIs are resolved by both regular and part serializers.
+</p>
+</p>
 </div><!-- END: 7.18 - juneau-rest-server.URIs -->
 
 <!-- ====================================================================================================
-->
diff --git a/juneau-doc/src/main/resources/Topics/02.juneau-marshall/16.URIs.html b/juneau-doc/src/main/resources/Topics/02.juneau-marshall/16.URIs.html
index 368b682..71ed515 100644
--- a/juneau-doc/src/main/resources/Topics/02.juneau-marshall/16.URIs.html
+++ b/juneau-doc/src/main/resources/Topics/02.juneau-marshall/16.URIs.html
@@ -57,8 +57,7 @@
 			<jf>f4a</jf> = URI.<jsm>create</jsm>(<js>"request:/f4a/x"</js>),
 			<jf>f4b</jf> = URI.<jsm>create</jsm>(<js>"request:/f4b"</js>),
 			<jf>f4c</jf> = URI.<jsm>create</jsm>(<js>"request:/"</js>),
-			<jf>f4d</jf> = URI.<jsm>create</jsm>(<js>"request:/.."</js>),
-			<jf>f5 </jf> = <jk>null</jk>;
+			<jf>f4d</jf> = URI.<jsm>create</jsm>(<js>"request:/.."</js>);;
 	}	
 	
 	<jc>// Create a serializer.</jc>
@@ -89,7 +88,7 @@
 	<jc>//	f4a:'http://foo.com:123/myContext/myServlet/myPath/f4a/x',</jc>
 	<jc>//	f4b:'http://foo.com:123/myContext/myServlet/myPath/f4b',</jc>
 	<jc>//	f4c:'http://foo.com:123/myContext/myServlet/myPath',</jc>
-	<jc>//	f4d:'http://foo.com:123/myContext/myServlet',</jc>
+	<jc>//	f4d:'http://foo.com:123/myContext/myServlet'</jc>
 	<jc>// }</jc>
 	String json = s.serialize(<jk>new</jk> TestURIs());
 </p>
diff --git a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/18.URIs.html b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/18.URIs.html
index 31c84a9..5be66f7 100644
--- a/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/18.URIs.html
+++ b/juneau-doc/src/main/resources/Topics/07.juneau-rest-server/18.URIs.html
@@ -13,7 +13,7 @@
  ***************************************************************************************************************************/
  -->
 
-{todo} URIs
+{new} URIs
 
 <p>
 	As mention earlier <a class='doclink' href='#juneau-marshall.URIs'>here</a>,
Juneau serializers have sophisticated support for transforming relative URIs to absolute form.
@@ -23,31 +23,34 @@
 </p>
 <p class='bpcode w800'>
 	<ja>@RestResource</ja>(
+		uriAuthority=<js>"http://foo.com:123"</js>,
+		uriContext=<js>"/myContext"</js>
 	)
-		
-	<ja>@RestMethod</ja>
-	<jk>public</jk> URI[] getURIs() {
-		<jk>return new</jk> URI[] {
-			URI.<jsm>create</jsm>(<js>"http://www.apache.org/f1a"</js>),
-			URI.<jsm>create</jsm>(<js>"/f1b"</js>),
-			URI.<jsm>create</jsm>(<js>"/f1c/x/y"</js>),
-			URI.<jsm>create</jsm>(<js>"f1d"</js>),
-			URI.<jsm>create</jsm>(<js>"f1e/x/y"</js>),
-			URI.<jsm>create</jsm>(<js>""</js>),
-			URI.<jsm>create</jsm>(<js>"context:/f2a/x"</js>),
-			URI.<jsm>create</jsm>(<js>"context:/f2b"</js>),
-			URI.<jsm>create</jsm>(<js>"context:/"</js>),
-			URI.<jsm>create</jsm>(<js>"context:/.."</js>),
-			URI.<jsm>create</jsm>(<js>"servlet:/f3a/x"</js>),
-			URI.<jsm>create</jsm>(<js>"servlet:/f3b"</js>),
-			URI.<jsm>create</jsm>(<js>"servlet:/"</js>),
-			URI.<jsm>create</jsm>(<js>"servlet:/.."</js>),
-			URI.<jsm>create</jsm>(<js>"request:/f4a/x"</js>),
-			URI.<jsm>create</jsm>(<js>"request:/f4b"</js>),
-			URI.<jsm>create</jsm>(<js>"request:/"</js>),
-			URI.<jsm>create</jsm>(<js>"request:/.."</js>),
-			<jk>null</jk>
-		};
+	<jk>public class</jk> MyResource {
+	
+		<ja>@RestMethod</ja>
+		<jk>public</jk> URI[] getURIs() {
+			<jk>return new</jk> URI[] {
+				URI.<jsm>create</jsm>(<js>"http://www.apache.org/f1a"</js>),
+				URI.<jsm>create</jsm>(<js>"/f1b"</js>),
+				URI.<jsm>create</jsm>(<js>"/f1c/x/y"</js>),
+				URI.<jsm>create</jsm>(<js>"f1d"</js>),
+				URI.<jsm>create</jsm>(<js>"f1e/x/y"</js>),
+				URI.<jsm>create</jsm>(<js>""</js>),
+				URI.<jsm>create</jsm>(<js>"context:/f2a/x"</js>),
+				URI.<jsm>create</jsm>(<js>"context:/f2b"</js>),
+				URI.<jsm>create</jsm>(<js>"context:/"</js>),
+				URI.<jsm>create</jsm>(<js>"context:/.."</js>),
+				URI.<jsm>create</jsm>(<js>"servlet:/f3a/x"</js>),
+				URI.<jsm>create</jsm>(<js>"servlet:/f3b"</js>),
+				URI.<jsm>create</jsm>(<js>"servlet:/"</js>),
+				URI.<jsm>create</jsm>(<js>"servlet:/.."</js>),
+				URI.<jsm>create</jsm>(<js>"request:/f4a/x"</js>),
+				URI.<jsm>create</jsm>(<js>"request:/f4b"</js>),
+				URI.<jsm>create</jsm>(<js>"request:/"</js>),
+				URI.<jsm>create</jsm>(<js>"request:/.."</js>)
+			};
+		}
 	}	
 </p>
 <p>
@@ -55,27 +58,41 @@
 </p>
 <p class='bpcode w800'>
 	{
-		f1a:'http://www.apache.org/f1a',
-		f1b:'http://foo.com:123/f1b',
-		f1c:'http://foo.com:123/f1c/x/y',
-		f1d:'http://foo.com:123/myContext/myServlet/f1d',
-		f1e:'http://foo.com:123/myContext/myServlet/f1e/x/y',
-		f1f:'http://foo.com:123/myContext/myServlet',
-		f2a:'http://foo.com:123/myContext/f2a/x',
-		f2b:'http://foo.com:123/myContext/f2b',
-		f2c:'http://foo.com:123/myContext',
-		f2d:'http://foo.com:123'
-		f3a:'http://foo.com:123/myContext/myServlet/f3a/x',
-		f3b:'http://foo.com:123/myContext/myServlet/f3b',
-		f3c:'http://foo.com:123/myContext/myServlet',
-		f3d:'http://foo.com:123/myContext',
-		f4a:'http://foo.com:123/myContext/myServlet/myPath/f4a/x',
-		f4b:'http://foo.com:123/myContext/myServlet/myPath/f4b',
-		f4c:'http://foo.com:123/myContext/myServlet/myPath',
-		f4d:'http://foo.com:123/myContext/myServlet',
+		<jok>f1a</jok>:<jov>'http://www.apache.org/f1a'</jov>,
+		<jok>f1b</jok>:<jov>'http://foo.com:123/f1b'</jov>,
+		<jok>f1c</jok>:<jov>'http://foo.com:123/f1c/x/y'</jov>,
+		<jok>f1d</jok>:<jov>'http://foo.com:123/myContext/myServlet/f1d'</jov>,
+		<jok>f1e</jok>:<jov>'http://foo.com:123/myContext/myServlet/f1e/x/y'</jov>,
+		<jok>f1f</jok>:<jov>'http://foo.com:123/myContext/myServlet'</jov>,
+		<jok>f2a</jok>:<jov>'http://foo.com:123/myContext/f2a/x'</jov>,
+		<jok>f2b</jok>:<jov>'http://foo.com:123/myContext/f2b'</jov>,
+		<jok>f2c</jok>:<jov>'http://foo.com:123/myContext'</jov>,
+		<jok>f2d</jok>:<jov>'http://foo.com:123'</jov>,
+		<jok>f3a</jok>:<jov>'http://foo.com:123/myContext/myServlet/f3a/x'</jov>,
+		<jok>f3b</jok>:<jov>'http://foo.com:123/myContext/myServlet/f3b'</jov>,
+		<jok>f3c</jok>:<jov>'http://foo.com:123/myContext/myServlet'</jov>,
+		<jok>f3d</jok>:<jov>'http://foo.com:123/myContext'</jov>,
+		<jok>f4a</jok>:<jov>'http://foo.com:123/myContext/myServlet/myPath/f4a/x'</jov>,
+		<jok>f4b</jok>:<jov>'http://foo.com:123/myContext/myServlet/myPath/f4b'</jov>,
+		<jok>f4c</jok>:<jov>'http://foo.com:123/myContext/myServlet/myPath'</jov>,
+		<jok>f4d</jok>:<jov>'http://foo.com:123/myContext/myServlet'</jov>
 	}
 </p>
 <p>
 	URI resolution is controlled by the following settings:
 </p>
+<ul class='doctree'>
+	<li class='jc'>{@link org.apache.juneau.rest.RestContext}
+	<ul>
+		<li class='jf'>{@link org.apache.juneau.rest.RestContext#REST_uriAuthority REST_uriAuthority}
+		<li class='jf'>{@link org.apache.juneau.rest.RestContext#REST_uriContext REST_uriContext}
+		<li class='jf'>{@link org.apache.juneau.rest.RestContext#REST_uriRelativity REST_uriRelativity}
+		<li class='jf'>{@link org.apache.juneau.rest.RestContext#REST_uriResolution REST_uriResolution}
+	</ul>	
+</ul>
+
+<p>
+	URIs are resolved by both regular and part serializers.
+</p>
+</p>
 
diff --git a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/ResourceDescription.java
b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/ResourceDescription.java
index bcbe137..0ff4ff4 100644
--- a/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/ResourceDescription.java
+++ b/juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/helper/ResourceDescription.java
@@ -17,7 +17,10 @@ import org.apache.juneau.html.annotation.*;
 import org.apache.juneau.http.annotation.*;
 
 /**
- * Shortcut label for child resources.  Typically used in router resources.
+ * Shortcut label for child resources.
+ *
+ * <p>
+ * Typically used in router resources.
  *
  * <h5 class='section'>Example:</h5>
  * <p class='bcode w800'>


Mime
View raw message