org.apache.juneau.rest.labels

Class ResourceDescription

java.lang.Object

org.apache.juneau.rest.labels.NameDescription

org.apache.juneau.rest.labels.ResourceDescription

All Implemented Interfaces:

Comparable<ResourceDescription>

public final class ResourceDescription
extends NameDescription
implements Comparable<ResourceDescription>

Shortcut label for child resources. Typically used in router resources.

Example:

new ResourceLink("httpTool", "HTTP request test client");

See Also:

• Overview > juneau-rest-server > Predefined Label Beans

Constructor Summary

Constructors

Constructor and Description
ResourceDescription() No-arg constructor.
ResourceDescription(String name, String description) Constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ResourceDescription o)
boolean	equals(Object o)
Object	getName() Returns the name field on this label.
int	hashCode()

Methods inherited from class org.apache.juneau.rest.labels.NameDescription

description, getDescription, name

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResourceDescription

public ResourceDescription(String name,
                           String description)

Constructor.

Parameters:

name - The name of the child resource.

description - The description of the child resource.

ResourceDescription

public ResourceDescription()

No-arg constructor. Used for JUnit testing of OPTIONS pages.

Method Detail

getName

@Html(link="servlet:/{name}")
public Object getName()

Description copied from class: NameDescription

Returns the name field on this label.

Overrides:

getName in class NameDescription

Returns:

The name.

compareTo

public int compareTo(ResourceDescription o)

Specified by:

compareTo in interface Comparable<ResourceDescription>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object