All Implemented Interfaces:

ai.platon.pulsar.common.urls.ComparableUrlAware , ai.platon.pulsar.common.urls.UrlAware , kotlin.Comparable
```
public class Hyperlink
extends AbstractUrl
                    
```
A hyperlink, or simply a link, is a reference to data that the user can follow by clicking or tapping.
A hyperlink points to a whole document or to a specific element within a document. Hypertext is text with hyperlinks. The text that is linked from is called anchor text.
The anchor text, link label or link text is the visible, clickable text in an HTML hyperlink.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`Hyperlink.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`configuredUrl`
`private final Boolean`	`isStandard`
`private final URL`	`toURL`
`private final URL`	`toURLOrNull`
`private final Boolean`	`isNil`
`private final Boolean`	`isPersistable`
`private final String`	`label`
`private final Instant`	`deadline`
`private String`	`url`
`private String`	`text`
`private Integer`	`order`
`private String`	`referrer`
`private String`	`args`
`private String`	`href`
`private Integer`	`priority`
`private String`	`lang`
`private String`	`country`
`private String`	`district`
`private Integer`	`nMaxRetry`
`private Integer`	`depth`
`public final static Hyperlink.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
`Hyperlink(String url)`	Construct a hyperlink.
`Hyperlink(UrlAware url)`
`Hyperlink(Hyperlink link)`
`Hyperlink(HyperlinkDatum datum)`
`Hyperlink(String url, String text, Integer order, String referrer, String args, String href, Integer priority, String lang, String country, String district, Integer nMaxRetry, Integer depth)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final HyperlinkDatum`	`data()`
`final HyperlinkDatum`	`toDatum()`
`StringBuilder`	`serializeTo(StringBuilder sb)`	Serialize the hyperlink to a string in command line style.
`Boolean`	`isDefault(String fieldName)`	Check if the option value is the default.

Methods inherited from class ai.platon.pulsar.common.urls.AbstractUrl
compareTo, equals, getArgs, getConfiguredUrl, getCountry, getDeadline, getDepth, getDistrict, getHref, getLabel, getLang, getNMaxRetry, getOrder, getPriority, getReferrer, getText, getToURL, getToURLOrNull, getUrl, hashCode, isNil, isPersistable, isStandard, serialize, setArgs, setCountry, setDepth, setDistrict, setHref, setLang, setNMaxRetry, setOrder, setPriority, setReferrer, setText, setUrl, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Hyperlink
```
Hyperlink(String url)
```
Construct a hyperlink.

Hyperlink
```
Hyperlink(UrlAware url)
```

Hyperlink
```
Hyperlink(Hyperlink link)
```

Hyperlink
```
Hyperlink(HyperlinkDatum datum)
```

Hyperlink

Hyperlink(String url, String text, Integer order, String referrer, String args, String href, Integer priority, String lang, String country, String district, Integer nMaxRetry, Integer depth)

Method Detail
- data
```
 final HyperlinkDatum data()
```
- toDatum
```
 final HyperlinkDatum toDatum()
```
- serializeTo
```
 StringBuilder serializeTo(StringBuilder sb)
```
  Serialize the hyperlink to a string in command line style.
  TODO: can handle only simple string values, need to be fixed
  
  Returns:
  
  the serialized string
- isDefault
```
 Boolean isDefault(String fieldName)
```
  Check if the option value is the default.

Class Hyperlink

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class ai.platon.pulsar.common.urls.AbstractUrl

Methods inherited from class java.lang.Object

Constructor Detail

Hyperlink

Hyperlink

Hyperlink

Hyperlink

Hyperlink

Method Detail

data

toDatum

serializeTo

isDefault