Package org.apache.juneau.rest.server.beans

Class RouteDescriptions

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<RouteDescription>

org.apache.juneau.rest.server.beans.RouteDescriptions

All Implemented Interfaces:

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

public class RouteDescriptions
extends ArrayList<RouteDescription>

A list of RouteDescription objects.

Typically returned by a route-index op so the listing is content-negotiated through the configured serializers (browsable HTML table, JSON, or XML based on the Accept header), mirroring the way ChildResourceDescriptions backs the child-resource navigation page.

See Also:

• RouteDescription
• ResourceDescriptions
• Utility Beans

Since:

10.0.0

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
RouteDescriptions()

Method Summary

Modifier and Type	Method	Description
RouteDescriptions	append(String path, List<String> methods, String summary, String description, boolean deprecated)	Adds a new RouteDescription to this list.
static RouteDescriptions	create()	Static creator.

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

RouteDescriptions

public RouteDescriptions()

Method Details

create

public static RouteDescriptions create()

Static creator.

Returns:

A new RouteDescriptions object.

append

public RouteDescriptions append(String path,
 List<String> methods,
 String summary,
 String description,
 boolean deprecated)

Adds a new RouteDescription to this list.

Parameters:

path - The mount path of the operation.

methods - The HTTP methods the operation responds to.

summary - The operation summary.

description - The operation description.

deprecated - Whether the operation is deprecated.

Returns:

This object.