org.apache.juneau.rest.helper

Class ResourceDescription

java.lang.Object

org.apache.juneau.rest.helper.ResourceDescription

All Implemented Interfaces:

Comparable<ResourceDescription>

@Bean(properties="name,description",
      fluentSetters=true)
 @Response(schema=@Schema(ignore=true))
public final class ResourceDescription
extends Object
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 > @RestMethod > Predefined Helper 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)
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.
int	hashCode()
ResourceDescription	name(String name) Sets the name 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 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 String getName()

Returns the name field on this label.

Returns:

The name.

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 (for method chaining).

getDescription

public String getDescription()

Returns the description field on this label.

Returns:

The description.

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 (for method chaining).

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