org.apache.juneau.dto

Class LinkString

java.lang.Object

org.apache.juneau.dto.LinkString

All Implemented Interfaces:

Comparable<LinkString>

Direct Known Subclasses:

DirectoryResource.Action, LogsResource.Action

@HtmlLink
 @Bean(fluentSetters=true)
public class LinkString
extends Object
implements Comparable<LinkString>

Simple bean that implements a hyperlink for the HTML serializer.

The name and url properties correspond to the following parts of a hyperlink in an HTML document...

<a href='href'>name</a>

When encountered by the HtmlSerializer class, this object gets converted to a hyperlink. All other serializers simply convert it to a simple bean.

Constructor Summary

Constructors

Constructor and Description
LinkString() No-arg constructor.
LinkString(String name, String uri, Object... uriArgs) Constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(LinkString o)
boolean	equals(Object o)
String	getHref() Deprecated. Use getUri()
String	getName() Bean property getter: name.
URI	getUri() Bean property getter: uri.
int	hashCode()
LinkString	name(String name) Bean property setter: name.
LinkString	setHref(String href) Deprecated. Use uri(String,Object...).
LinkString	setHref(String href, Object... args) Deprecated. Use uri(String,Object...).
LinkString	setName(String name) Deprecated. Use name(String).
String	toString() Returns the name so that the PojoQuery class can search against it.
LinkString	uri(String uri) Bean property setter: uri.
LinkString	uri(String uri, Object... args) Bean property setter: uri.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkString

public LinkString()

No-arg constructor.

LinkString

public LinkString(String name,
                  String uri,
                  Object... uriArgs)

Constructor.

Parameters:

name - Corresponds to the text inside of the <A> element.

uri - Corresponds to the value of the href attribute of the <A> element.

uriArgs - Optional arguments for MessageFormat style arguments in the href.

Method Detail

getName

public String getName()

Bean property getter: name.

Corresponds to the text inside of the <A> element.

Returns:

The value of the name property on this bean, or null if it is not set.

name

public LinkString name(String name)

Bean property setter: name.

Parameters:

name - The new value for the name property on this bean.

Returns:

This object (for method chaining).

getUri

public URI getUri()

Bean property getter: uri.

Corresponds to the value of the href attribute of the <A> element.

Returns:

The value of the href property on this bean, or null if it is not set.

uri

public LinkString uri(String uri)

Bean property setter: uri.

Parameters:

uri - The new value for the href property on this bean.

Returns:

This object (for method chaining).

uri

public LinkString uri(String uri,
                      Object... args)

Bean property setter: uri.

Same as uri(String) except allows for MessageFormat style arguments.

Parameters:

uri - The new href.

args - Optional MessageFormat-style arguments.

Returns:

This object (for method chaining).

toString

public String toString()

Returns the name so that the PojoQuery class can search against it.

Overrides:

toString in class Object

compareTo

public int compareTo(LinkString o)

Specified by:

compareTo in interface Comparable<LinkString>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getHref

@Deprecated
public String getHref()

Deprecated. Use getUri()

setName

@Deprecated
public LinkString setName(String name)

Deprecated. Use name(String).

setHref

@Deprecated
public LinkString setHref(String href,
                                      Object... args)

Deprecated. Use uri(String,Object...).

setHref

@Deprecated
public LinkString setHref(String href)

Deprecated. Use uri(String,Object...).