LinkString (Apache Juneau 7.0.0-SNAPSHOT)

java.lang.Object
+
- org.apache.juneau.dto.LinkString
+

+
+
All Implemented Interfaces:
+
Comparable<LinkString>
+
+
+
+
```
@HtmlLink(nameProperty="name",
+          hrefProperty="href")
+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 href, + Object... hrefArgs) +
Constructor.
+
+

Constructors
Constructor and Description
`LinkString()` + No-arg constructor. +
`LinkString(String name, + String href, + Object... hrefArgs)` + Constructor. +

+ +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(LinkString o)`
`boolean`	`equals(Object o)`
`String`	`getHref()` + Bean property getter: href. +
`String`	`getName()` + Bean property getter: name. +
`int`	`hashCode()`
`LinkString`	`setHref(String href)` + Bean property setter: href. +
`LinkString`	`setHref(String href, + Object... args)` + Bean property setter: href. +
`LinkString`	`setName(String name)` + Bean property setter: name. +
`String`	`toString()` + Returns the name so that the `PojoQuery` class can search against it. +

+ + +
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 href,
+                  Object... hrefArgs)
```
    +
    Constructor.
    +
    +
    Parameters:
    +
    name - Corresponds to the text inside of the <A> element.
    +
    href - Corresponds to the value of the href attribute of the <A> element.
    +
    hrefArgs - 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.
    +
    +
  + + + +
  - +
    setName
    +
```
public LinkString setName(String name)
```
    +
    Bean property setter: name.
    +
    +
    Parameters:
    +
    name - The new value for the name property on this bean.
    +
    Returns:
    +
    This object (for method chaining).
    +
    +
  + + + +
  - +
    getHref
    +
```
public String getHref()
```
    +
    Bean property getter: href. + +
    + 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.
    +
    +
  + + + +
  - +
    setHref
    +
```
public LinkString setHref(String href)
```
    +
    Bean property setter: href.
    +
    +
    Parameters:
    +
    href - The new value for the href property on this bean.
    +
    Returns:
    +
    This object (for method chaining).
    +
    +
  + + + +
  - +
    setHref
    +
```
public LinkString setHref(String href,
+                          Object... args)
```
    +
    Bean property setter: href. + +
    + Same as setHref(String) except allows for MessageFormat style arguments.
    +
    +
    Parameters:
    +
    href - 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
    +
    +
  +
+

Class LinkString

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LinkString

LinkString

Method Detail

getName

setName

getHref

setHref

setHref

toString

compareTo

equals

hashCode