Module com.aoapps.net.partialurl

Package com.aoapps.net.partialurl

Class SinglePartialURL

java.lang.Object

com.aoapps.net.partialurl.PartialURL

com.aoapps.net.partialurl.SinglePartialURL

All Implemented Interfaces:

Comparable<SinglePartialURL>

public class SinglePartialURL
extends PartialURL
implements Comparable<SinglePartialURL>

A PartialURL that may contain at most one values for each field matched. All fields are optional.

Field Summary

Fields inherited from class com.aoapps.net.partialurl.PartialURL

DEFAULT, HTTP, HTTPS, NULL_CONTEXT_PATH, NULL_PREFIX, WILDCARD_CHAR, WILDCARD_STRING

Method Summary

Modifier and Type	Method	Description
int	compareTo(SinglePartialURL other)
boolean	equals(Object obj)
Iterable<SinglePartialURL>	getCombinations()	Gets all combinations of single partial URLs represented by this partial URL.
Path	getContextPath()	Gets the context path for this partial URL, only ending in a slash (/) when is the root context.
HostAddress	getHost()	Gets the IP address or hostname for this partial URL.
Port	getPort()	Gets the port number for this partial URL.
Path	getPrefix()	Gets the prefix of the path for this partial URL, always either null or ending in a slash (/).
SinglePartialURL	getPrimary()	Gets the primary single partial URL for this partial URL.
String	getScheme()	Gets the lower-case scheme (such as https/http/other) for this partial URL.
int	hashCode()
boolean	isComplete()	Checks if this partial URL is complete (has no null fields other than prefix).
SinglePartialURL	matches(FieldSource fieldSource)	Checks if the given FieldSource matches this partial URL.
String	toString()
URL	toURL(FieldSource fieldSource)	Gets the general-purpose representation of URL for this partial URL.

Methods inherited from class com.aoapps.net.partialurl.PartialURL

valueOf, valueOf, valueOf, valueOf, valueOf, valueOf

Methods inherited from class java.lang.Object

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

Method Details

toString

public String toString()

Specified by:

toString in class PartialURL

equals

public boolean equals(Object obj)

Specified by:

equals in class PartialURL

hashCode

public int hashCode()

Specified by:

hashCode in class PartialURL

compareTo

public int compareTo(SinglePartialURL other)

Ordering is consistent with:

• PartialURL.matches(com.aoapps.net.partialurl.FieldSource)
• PartialURL.getCombinations()
• PartialURLMap.get(com.aoapps.net.partialurl.FieldSource)

Specified by:

compareTo in interface Comparable<SinglePartialURL>

See Also:

• PartialURL.getCombinations()

matches

public SinglePartialURL matches(FieldSource fieldSource)
                         throws MalformedURLException

Checks if the given FieldSource matches this partial URL.

The SinglePartialURL returned, if any, is also in the set of partial URLs provided by PartialURL.getCombinations(). Specifically, the match must be equivalent to the first match found by iterative calls to the results of PartialURL.getCombinations(), using matches(com.aoapps.net.partialurl.FieldSource) on each single partial. The implementation, however, does not need to be iterative.

Ordering is consistent with:

• PartialURL.getCombinations()
• compareTo(com.aoapps.net.partialurl.SinglePartialURL)
• PartialURLMap.get(com.aoapps.net.partialurl.FieldSource)

Specified by:

matches in class PartialURL

Parameters:

fieldSource - When all fields are null (this is PartialURL.DEFAULT), this is not used and may be null.

Returns:

this when matches, or null when does not match.

Throws:

MalformedURLException

isComplete

public boolean isComplete()

Description copied from class: PartialURL

Checks if this partial URL is complete (has no null fields other than prefix). A complete URL may be converted to a URL without any field source provided.

Specified by:

isComplete in class PartialURL

See Also:

• PartialURL.toURL(com.aoapps.net.partialurl.FieldSource)

getPrimary

public SinglePartialURL getPrimary()

Gets the primary single partial URL for this partial URL.

This will always be found in PartialURL.getCombinations().

Implementation Note:
a partial URL is its own primary

Specified by:

getPrimary in class PartialURL

Returns:

this because it is already a single partial URL

See Also:

• PartialURL.getCombinations()

getCombinations

public Iterable<SinglePartialURL> getCombinations()

Gets all combinations of single partial URLs represented by this partial URL.

Ordering is consistent with:

• PartialURL.matches(com.aoapps.net.partialurl.FieldSource)
• compareTo(com.aoapps.net.partialurl.SinglePartialURL)
• PartialURLMap.get(com.aoapps.net.partialurl.FieldSource)

When one of the results is equal to the primary, returns the same object instance as PartialURL.getPrimary().

Implementation Note:
iterates over this only

Specified by:

getCombinations in class PartialURL

See Also:

• PartialURL.getPrimary()
• compareTo(com.aoapps.net.partialurl.SinglePartialURL)

toURL

public URL toURL(FieldSource fieldSource)
          throws MalformedURLException

Description copied from class: PartialURL

Gets the general-purpose representation of URL for this partial URL.

Specified by:

toURL in class PartialURL

Parameters:

fieldSource - Only used when at least one field is null and uses the value from the source. May be null when this PartialURL is known to have all fields specified.

Throws:

MalformedURLException

See Also:

• PartialURL.isComplete()

getScheme

public String getScheme()

Gets the lower-case scheme (such as https/http/other) for this partial URL.

Returns:

The scheme or null when FieldSource.getScheme() should be used.

See Also:

• PartialURL.HTTP
• PartialURL.HTTPS
• FieldSource.getScheme()

getHost

public HostAddress getHost()

Gets the IP address or hostname for this partial URL.

Returns:

The IP address/hostname or null when FieldSource.getHost() should be used.

See Also:

• FieldSource.getHost()

getPort

public Port getPort()

Gets the port number for this partial URL.

Returns:

The port or null when FieldSource.getPort() should be used.

See Also:

• FieldSource.getPort()

getContextPath

public Path getContextPath()

Gets the context path for this partial URL, only ending in a slash (/) when is the root context.

Returns:

The context path or null when the context path of the field source should be used.

See Also:

• FieldSource.getContextPath()

getPrefix

public Path getPrefix()

Gets the prefix of the path for this partial URL, always either null or ending in a slash (/). This is matched as a prefix of FieldSource.getPath().

See Also:

• FieldSource.getPath()
• Path.SEPARATOR_CHAR