org.apache.juneau.rest.labels

Class NameDescription

java.lang.Object

org.apache.juneau.rest.labels.NameDescription

Direct Known Subclasses:

ResourceDescription

@Bean(properties="name,description")
public class NameDescription
extends Object

Simple bean with name and description properties.

Primarily used for constructing tables with name/description columns on REST OPTIONS requests.

See Also:

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

Constructor Summary

Constructors

Constructor and Description
NameDescription() No-arg constructor.
NameDescription(Object name, Object description) Constructor.

Method Summary

Modifier and Type	Method and Description
NameDescription	description(Object description) Sets the description field on this label to a new value.
Object	getDescription() Returns the description field on this label.
Object	getName() Returns the name field on this label.
NameDescription	name(Object name) Sets the name field on this label to a new value.

Methods inherited from class java.lang.Object

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

Constructor Detail

NameDescription

public NameDescription()

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

NameDescription

public NameDescription(Object name,
                       Object description)

Constructor.

Parameters:

name - A name.

description - A description.

Method Detail

getName

public Object getName()

Returns the name field on this label.

Returns:

The name.

name

@BeanProperty
public NameDescription name(Object 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 Object getDescription()

Returns the description field on this label.

Returns:

The description.

description

@BeanProperty
public NameDescription description(Object description)

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

Parameters:

description - The new description.

Returns:

This object (for method chaining).