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.

Field Summary

Fields
Modifier and Type	Field	Description
`private Integer`	`depth`
`private String`	`text`
`private Integer`	`order`
`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`	`lang`
`private String`	`country`
`private String`	`district`
`private Integer`	`nMaxRetry`
`private String`	`url`
`private String`	`args`
`private String`	`referrer`
`private String`	`href`
`private Integer`	`priority`
`private final String`	`referer`
`private final Instant`	`deadTime`

Constructor Summary

Constructors
Constructor	Description
`Hyperlink(UrlAware url)`
`Hyperlink(Hyperlink url)`
`Hyperlink(HyperlinkDatum url)`
`Hyperlink(String url, String text, Integer order, String referrer, String args, String href)`

Method Summary

Modifier and Type	Method	Description
`final Integer`	`getDepth()`
`final Unit`	`setDepth(Integer depth)`
`final String`	`getText()`	The anchor text
`final Unit`	`setText(String text)`	The anchor text
`final Integer`	`getOrder()`	The order of this hyperlink in it referrer page
`final Unit`	`setOrder(Integer order)`	The order of this hyperlink in it referrer page
`String`	`getConfiguredUrl()`
`Boolean`	`getIsStandard()`
`URL`	`getToURL()`
`URL`	`getToURLOrNull()`
`Boolean`	`getIsNil()`
`Boolean`	`getIsPersistable()`	If this url is persistable
`String`	`getLabel()`
`Instant`	`getDeadline()`
`String`	`getLang()`	Required website language
`Unit`	`setLang(String lang)`	Required website language
`String`	`getCountry()`	Required website country
`Unit`	`setCountry(String country)`	Required website country
`String`	`getDistrict()`	Required website district
`Unit`	`setDistrict(String district)`	Required website district
`Integer`	`getNMaxRetry()`	The maximum retry times
`Unit`	`setNMaxRetry(Integer nMaxRetry)`	The maximum retry times
`String`	`getUrl()`	The url specification, it is usually normalized, and can contain load arguments.
`Unit`	`setUrl(String url)`	The url specification, it is usually normalized, and can contain load arguments.
`String`	`getArgs()`	The url args
`Unit`	`setArgs(String args)`	The url args
`String`	`getReferrer()`	The referrer
`Unit`	`setReferrer(String referrer)`	The referrer
`String`	`getHref()`	The hypertext reference, It defines the address of the document, which this time is linked from
`Unit`	`setHref(String href)`	The hypertext reference, It defines the address of the document, which this time is linked from
`Integer`	`getPriority()`	The priority
`Unit`	`setPriority(Integer priority)`	The priority
`String`	`getReferer()`
`Instant`	`getDeadTime()`
`final HyperlinkDatum`	`data()`

Methods inherited from class ai.platon.pulsar.common.urls.Hyperlink
compareTo, equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Hyperlink
```
Hyperlink(UrlAware url)
```
  - Hyperlink
```
Hyperlink(Hyperlink url)
```
  - Hyperlink
```
Hyperlink(HyperlinkDatum url)
```
  - Hyperlink
```
Hyperlink(String url, String text, Integer order, String referrer, String args, String href)
```
- Method Detail
  - getDepth
```
 final Integer getDepth()
```
  - setDepth
```
 final Unit setDepth(Integer depth)
```
  - getText
```
 final String getText()
```
    The anchor text
  - setText
```
 final Unit setText(String text)
```
    The anchor text
  - getOrder
```
 final Integer getOrder()
```
    The order of this hyperlink in it referrer page
  - setOrder
```
 final Unit setOrder(Integer order)
```
    The order of this hyperlink in it referrer page
  - getConfiguredUrl
```
 String getConfiguredUrl()
```
  - getIsStandard
```
 Boolean getIsStandard()
```
  - getToURL
```
 URL getToURL()
```
  - getToURLOrNull
```
 URL getToURLOrNull()
```
  - getIsNil
```
 Boolean getIsNil()
```
  - getIsPersistable
```
 Boolean getIsPersistable()
```
    If this url is persistable
  - getLabel
```
 String getLabel()
```
  - getDeadline
```
 Instant getDeadline()
```
  - getLang
```
 String getLang()
```
    Required website language
  - setLang
```
 Unit setLang(String lang)
```
    Required website language
  - getCountry
```
 String getCountry()
```
    Required website country
  - setCountry
```
 Unit setCountry(String country)
```
    Required website country
  - getDistrict
```
 String getDistrict()
```
    Required website district
  - setDistrict
```
 Unit setDistrict(String district)
```
    Required website district
  - getNMaxRetry
```
 Integer getNMaxRetry()
```
    The maximum retry times
  - setNMaxRetry
```
 Unit setNMaxRetry(Integer nMaxRetry)
```
    The maximum retry times
  - getUrl
```
 String getUrl()
```
    The url specification, it is usually normalized, and can contain load arguments.
  - setUrl
```
 Unit setUrl(String url)
```
    The url specification, it is usually normalized, and can contain load arguments.
  - getArgs
```
 String getArgs()
```
    The url args
  - setArgs
```
 Unit setArgs(String args)
```
    The url args
  - getReferrer
```
 String getReferrer()
```
    The referrer
  - setReferrer
```
 Unit setReferrer(String referrer)
```
    The referrer
  - getHref
```
 String getHref()
```
    The hypertext reference, It defines the address of the document, which this time is linked from
  - setHref
```
 Unit setHref(String href)
```
    The hypertext reference, It defines the address of the document, which this time is linked from
  - getPriority
```
 Integer getPriority()
```
    The priority
  - setPriority
```
 Unit setPriority(Integer priority)
```
    The priority
  - getReferer
```
 String getReferer()
```
  - getDeadTime
```
 Instant getDeadTime()
```
  - data
```
 final HyperlinkDatum data()
```

Class Hyperlink

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

Hyperlink

Hyperlink

Hyperlink

Hyperlink

Method Detail

getDepth

setDepth

getText

setText

getOrder

setOrder

getConfiguredUrl

getIsStandard

getToURL

getToURLOrNull

getIsNil

getIsPersistable

getLabel

getDeadline

getLang

setLang

getCountry

setCountry

getDistrict

setDistrict

getNMaxRetry

setNMaxRetry

getUrl

setUrl

getArgs

setArgs

getReferrer

setReferrer

getHref

setHref

getPriority

setPriority

getReferer

getDeadTime

data