Package org.apache.juneau.rest.beans

Class ChildResourceDescriptions

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<ResourceDescription>

org.apache.juneau.rest.beans.ResourceDescriptions

org.apache.juneau.rest.beans.ChildResourceDescriptions

All Implemented Interfaces:

Serializable, Cloneable, Iterable<ResourceDescription>, Collection<ResourceDescription>, List<ResourceDescription>, RandomAccess

public class ChildResourceDescriptions
extends ResourceDescriptions

A POJO structure that describes the list of child resources associated with a resource.

Typically used in top-level GET methods of router resources to render a list of available child resources.

See Also:

• Utility Beans
• BasicGroupOperations

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
ChildResourceDescriptions()	Bean constructor.
ChildResourceDescriptions(RestContext context, RestRequest req)	Constructor.
ChildResourceDescriptions(RestContext context, RestRequest req, boolean sort)	Constructor.
ChildResourceDescriptions(RestRequest req)	Constructor.

Method Summary

Modifier and Type	Method	Description
ChildResourceDescriptions	append(String name, String description)	Adds a new ResourceDescription to this list.
ChildResourceDescriptions	append(String name, String uri, String description)	Adds a new ResourceDescription to this list when the uri is different from the name.
static ChildResourceDescriptions	of(RestRequest req)	Static creator.

Methods inherited from class org.apache.juneau.rest.beans.ResourceDescriptions

create

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, equals, forEach, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

containsAll

Constructor Details

ChildResourceDescriptions

public ChildResourceDescriptions()

Bean constructor.

ChildResourceDescriptions

public ChildResourceDescriptions(RestContext context,
 RestRequest req)

Constructor.

Parameters:

context - The servlet context that this bean describes.

req - The HTTP servlet request.

ChildResourceDescriptions

public ChildResourceDescriptions(RestContext context,
 RestRequest req,
 boolean sort)

Constructor.

Parameters:

context - The servlet context that this bean describes.

req - The HTTP servlet request.

sort - If true, list will be ordered by name alphabetically. Default is to maintain the order as specified in the annotation.

ChildResourceDescriptions

public ChildResourceDescriptions(RestRequest req)

Constructor.

Parameters:

req - The HTTP servlet request.

Method Details

of

public static ChildResourceDescriptions of(RestRequest req)

Static creator.

Parameters:

req - The HTTP servlet request.

Returns:

A new ChildResourceDescriptions bean.

append

public ChildResourceDescriptions append(String name,
 String description)

Description copied from class: ResourceDescriptions

Adds a new ResourceDescription to this list.

Overrides:

append in class ResourceDescriptions

Parameters:

name - The name of the child resource.

description - The description of the child resource.

Returns:

This object.

append

public ChildResourceDescriptions append(String name,
 String uri,
 String description)

Description copied from class: ResourceDescriptions

Adds a new ResourceDescription to this list when the uri is different from the name.

Overrides:

append in class ResourceDescriptions

Parameters:

name - The name of the child resource.

uri - The URI of the child resource.

description - The description of the child resource.

Returns:

This object.