All Implemented Interfaces:
```
public interface UrlAware

                    
```
UrlAware encapsulates a URL along with additional specifications defining its loading behavior.
A URL represents a Uniform Resource Locator, a pointer to a "resource" on the World Wide Web. A resource can be something as simple as a file or a directory, or it can be a reference to a more complicated object, such as a query to a database or to a search engine.
In java, a URL object represents a URL. In PulsarRPA, a UrlAware object represents a URL with extra information telling the system how to fetch it.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract String`	`getUrl()`	The url specification, can be followed by load arguments.
`abstract Unit`	`setUrl(String url)`	The url specification, can be followed by load arguments.
`abstract String`	`getArgs()`	The explicitly specified load arguments
`abstract Unit`	`setArgs(String args)`	The explicitly specified load arguments
`abstract String`	`getHref()`	The hypertext reference, it defines the address of the document, which this time is linked from.
`abstract Unit`	`setHref(String href)`	The hypertext reference, it defines the address of the document, which this time is linked from.
`abstract String`	`getReferrer()`	The referrer url, it is the url of the webpage that contains the hyperlink.
`abstract Unit`	`setReferrer(String referrer)`	The referrer url, it is the url of the webpage that contains the hyperlink.
`abstract Integer`	`getPriority()`	Represents the priority of a task, determining the order of execution.
`abstract Unit`	`setPriority(Integer priority)`	Represents the priority of a task, determining the order of execution.
`abstract String`	`getConfiguredUrl()`	The configured url, always be "$url $args"
`abstract Boolean`	`isStandard()`	If true, the url is standard and can be converted to a java.net.URL
`abstract URL`	`getToURL()`	Converted to a java.net.URL
`abstract URL`	`getToURLOrNull()`	Converted to a java.net.URL, if the url is invalid, return null
`abstract Boolean`	`isNil()`	An url is Nil if it equals to AppConstants.
`abstract Boolean`	`isPersistable()`	If true, the url is persistable, it can be saved to the database.
`abstract String`	`getText()`	The text of the url, it can be the text of the hyperlink.
`abstract Unit`	`setText(String text)`	The text of the url, it can be the text of the hyperlink.
`abstract Integer`	`getOrder()`	The order of the url.
`abstract Unit`	`setOrder(Integer order)`	The order of the url.
`abstract String`	`getLabel()`	The url label, it should be a shortcut for `-label` option in load options
`abstract Instant`	`getDeadline()`	The deadline, it should be a shortcut for `-deadline` option in load options
`abstract String`	`getLang()`	Required website language, reserved for future use
`abstract String`	`getCountry()`	Required website country, reserved for future use
`abstract String`	`getDistrict()`	Required website district, reserved for future use
`abstract Integer`	`getNMaxRetry()`	The maximum retry times
`abstract Integer`	`getDepth()`	The depth of the url from the root url.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - getUrl
```
 abstract String getUrl()
```
    The url specification, can be followed by load arguments.
  - setUrl
```
 abstract Unit setUrl(String url)
```
    The url specification, can be followed by load arguments.
  - getArgs
```
 abstract String getArgs()
```
    The explicitly specified load arguments
  - setArgs
```
 abstract Unit setArgs(String args)
```
    The explicitly specified load arguments
  - getHref
```
 abstract String getHref()
```
    The hypertext reference, it defines the address of the document, which this time is linked from. The href is usually extracted from the webpage and serves as the browser's primary choice for navigation.
  - setHref
```
 abstract Unit setHref(String href)
```
    The hypertext reference, it defines the address of the document, which this time is linked from. The href is usually extracted from the webpage and serves as the browser's primary choice for navigation.
  - getReferrer
```
 abstract String getReferrer()
```
    The referrer url, it is the url of the webpage that contains the hyperlink.
  - setReferrer
```
 abstract Unit setReferrer(String referrer)
```
    The referrer url, it is the url of the webpage that contains the hyperlink.
  - getPriority
```
 abstract Integer getPriority()
```
    Represents the priority of a task, determining the order of execution.
    The priority value is an integer where a smaller value indicates a higher priority. This is consistent with java.util.concurrent.PriorityBlockingQueue.
    If the priority value is not within the range defined by Priority13, it will be adjusted to the nearest valid value. For example, a priority of -2001 will be adjusted to Priority13.HIGHER2.
    Note: The priority specified in args or LoadOptions takes precedence over the priority in UrlAware, Hyperlink, etc.
    Priority can be set in the following ways:
    In the url, for example, http://example.com -priority -2000
    In the args, for example, Hyperlink("http://example.com", "", args = "-priority -2000")
    Int the ai.platon.pulsar.skeleton.common.options.LoadOptions object, for example, session.load("http://example.com", options.apply { priority = -2000 })
    In the UrlAware object, for example, Hyperlink("http://example.com", "", priority = -2000)
    If a url is normalized like this:
    session.normalize(url: UrlAware, options: LoadOptions)
    The priority will be set in the following order:
    The priority in the url
    The priority in the args
    The priority in the options
    Note: Consider use url args to set priority only.
  - setPriority
```
 abstract Unit setPriority(Integer priority)
```
    Represents the priority of a task, determining the order of execution.
    The priority value is an integer where a smaller value indicates a higher priority. This is consistent with java.util.concurrent.PriorityBlockingQueue.
    If the priority value is not within the range defined by Priority13, it will be adjusted to the nearest valid value. For example, a priority of -2001 will be adjusted to Priority13.HIGHER2.
    Note: The priority specified in args or LoadOptions takes precedence over the priority in UrlAware, Hyperlink, etc.
    Priority can be set in the following ways:
    In the url, for example, http://example.com -priority -2000
    In the args, for example, Hyperlink("http://example.com", "", args = "-priority -2000")
    Int the ai.platon.pulsar.skeleton.common.options.LoadOptions object, for example, session.load("http://example.com", options.apply { priority = -2000 })
    In the UrlAware object, for example, Hyperlink("http://example.com", "", priority = -2000)
    If a url is normalized like this:
    session.normalize(url: UrlAware, options: LoadOptions)
    The priority will be set in the following order:
    The priority in the url
    The priority in the args
    The priority in the options
    Note: Consider use url args to set priority only.
  - getConfiguredUrl
```
 abstract String getConfiguredUrl()
```
    The configured url, always be "$url $args"
  - isStandard
```
 abstract Boolean isStandard()
```
    If true, the url is standard and can be converted to a java.net.URL
  - getToURL
```
 abstract URL getToURL()
```
    Converted to a java.net.URL
  - getToURLOrNull
```
 abstract URL getToURLOrNull()
```
    Converted to a java.net.URL, if the url is invalid, return null
  - isNil
```
 abstract Boolean isNil()
```
    An url is Nil if it equals to AppConstants.NIL_PAGE_URL
  - isPersistable
```
 abstract Boolean isPersistable()
```
    If true, the url is persistable, it can be saved to the database. Not all urls are persistable, for example, a ListenableHyperlink with events is not persistable.
  - getText
```
 abstract String getText()
```
    The text of the url, it can be the text of the hyperlink.
  - setText
```
 abstract Unit setText(String text)
```
    The text of the url, it can be the text of the hyperlink.
  - getOrder
```
 abstract Integer getOrder()
```
    The order of the url.
  - setOrder
```
 abstract Unit setOrder(Integer order)
```
    The order of the url.
  - getLabel
```
 abstract String getLabel()
```
    The url label, it should be a shortcut for -label option in load options
  - getDeadline
```
 abstract Instant getDeadline()
```
    The deadline, it should be a shortcut for -deadline option in load options
  - getLang
```
 abstract String getLang()
```
    Required website language, reserved for future use
  - getCountry
```
 abstract String getCountry()
```
    Required website country, reserved for future use
  - getDistrict
```
 abstract String getDistrict()
```
    Required website district, reserved for future use
  - getNMaxRetry
```
 abstract Integer getNMaxRetry()
```
    The maximum retry times
  - getDepth
```
 abstract Integer getDepth()
```
    The depth of the url from the root url.

Interface UrlAware

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

getUrl

setUrl

getArgs

setArgs

getHref

setHref

getReferrer

setReferrer

getPriority

setPriority

getConfiguredUrl

isStandard

getToURL

getToURLOrNull

isNil

isPersistable

getText

setText

getOrder

setOrder

getLabel

getDeadline

getLang

getCountry

getDistrict

getNMaxRetry

getDepth