Package org.apache.juneau.rest.beans

Class ResourceDescription

java.lang.Object

org.apache.juneau.rest.beans.ResourceDescription

All Implemented Interfaces:

Comparable<ResourceDescription>

@Bean(properties="name,description",
      findFluentSetters=true)
@Response(schema=@Schema(ignore=true))
public class ResourceDescription
extends Object
implements Comparable<ResourceDescription>

Shortcut label for child resources.

Typically used in router resources.

Example:

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

See Also:

• Utility Beans

Constructor Summary

Constructors

Constructor	Description
ResourceDescription()	No-arg constructor.
ResourceDescription(String name, String description)	Constructor for when the name and uri are the same.
ResourceDescription(String name, String uri, String description)	Constructor for when the name and uri are different.

Method Summary

Modifier and Type	Method	Description
int	compareTo(ResourceDescription o)
ResourceDescription	description(String description)	Sets the description field on this label to a new value.
boolean	equals(Object o)
String	getDescription()	Returns the description field on this label.
String	getName()	Returns the name field on this label.
String	getUri()	Returns the uri on this label.
int	hashCode()
ResourceDescription	name(String name)	Sets the name field on this label to a new value.
ResourceDescription	uri(String uri)	Sets the uri field on this label to a new value.

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceDescription

public ResourceDescription()

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

ResourceDescription

public ResourceDescription(String name,
 String description)

Constructor for when the name and uri are the same.

Parameters:

name - The name of the child resource.

description - The description of the child resource.

ResourceDescription

public ResourceDescription(String name,
 String uri,
 String description)

Constructor for when the name and uri are different.

Parameters:

name - The name of the child resource.

uri - The uri of the child resource.

description - The description of the child resource.

Method Details

compareTo

public int compareTo(ResourceDescription o)

Specified by:

compareTo in interface Comparable<ResourceDescription>

description

public ResourceDescription description(String description)

Sets the description field on this label to a new value.

Parameters:

description - The new description.

Returns:

This object.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getDescription

public String getDescription()

Returns the description field on this label.

Returns:

The description.

getName

@Html(link="servlet:/{uri}")
public String getName()

Returns the name field on this label.

Returns:

The name.

getUri

public String getUri()

Returns the uri on this label.

Returns:

The name.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

name

public ResourceDescription name(String name)

Sets the name field on this label to a new value.

Parameters:

name - The new name.

Returns:

This object.

uri

public ResourceDescription uri(String uri)

Sets the uri field on this label to a new value.

Parameters:

uri - The new uri.

Returns:

This object.