Module com.aoapps.net.partialurl

Package com.aoapps.net.partialurl

Class MultiPartialURL

java.lang.Object

com.aoapps.net.partialurl.PartialURL

com.aoapps.net.partialurl.MultiPartialURL

public class MultiPartialURL
extends PartialURL

A PartialURL that may contains multiple 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
boolean	equals(Object obj)
Iterable<SinglePartialURL>	getCombinations()	Gets all combinations of single partial URLs represented by this partial URL.
Set<Path>	getContextPaths()	Gets the unmodifiable set of context paths for this partial URL, only ending in a slash (/) when is the root context.
Set<HostAddress>	getHosts()	Gets the unmodifiable set of IP addresses or hostnames for this partial URL.
Set<Port>	getPorts()	Gets the unmodifiable set of port numbers for this partial URL.
Set<Path>	getPrefixes()	Gets the unmodifiable set of prefixes 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.
Set<String>	getSchemes()	Gets the unmodifiable set of lower-case schemes (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

matches

public SinglePartialURL matches(FieldSource fieldSource)
                         throws MalformedURLException

Description copied from class: PartialURL

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 SinglePartialURL.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()
• SinglePartialURL.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:

The SinglePartialURL with non-null fields selected to match the field source, or null when does not match. When the match is equals the primary, returns the same object as PartialURL.getPrimary().

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().

When there is not more than one prefix, this will be the first value returned from getCombinations().

Implementation Note:
Uses the first value from each set.

Specified by:

getPrimary in class PartialURL

See Also:

• 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)
• SinglePartialURL.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().

Sets are iterated in the following order:

1. getHosts()
2. getContextPaths()
3. getPrefixes() (sorted by deepest first for consistency with SinglePartialURL.compareTo(com.aoapps.net.partialurl.SinglePartialURL))
4. getPorts()
5. getSchemes()

When there is not more than one prefix, the first value returned will be the primary.

TODO: A more space-efficient implementation could generate these on-the-fly. Or should we just return the generated Set? Will depend on how his is used.

Implementation Note:
This currently generates the full set at the time of method invocation. This is not a performance-oriented implementation. Please see PartialURLMap for a fast way to index partial URLs.

Specified by:

getCombinations in class PartialURL

See Also:

• getPrimary()

toURL

public URL toURL(FieldSource fieldSource)
          throws MalformedURLException

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

Implementation Note:
This selects the specifically matching fields from each set when field source is non-null.

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()

getSchemes

public Set<String> getSchemes()

Gets the unmodifiable set of lower-case schemes (such as https/http/other) for this partial URL.

Returns:

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

See Also:

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

getHosts

public Set<HostAddress> getHosts()

Gets the unmodifiable set of IP addresses or hostnames for this partial URL.

Returns:

The IP addresses/hostnames or null when FieldSource.getHost() should be used.

See Also:

• FieldSource.getHost()

getPorts

public Set<Port> getPorts()

Gets the unmodifiable set of port numbers for this partial URL.

Returns:

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

See Also:

• FieldSource.getPort()

getContextPaths

public Set<Path> getContextPaths()

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

Returns:

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

See Also:

• FieldSource.getContextPath()

getPrefixes

public Set<Path> getPrefixes()

Gets the unmodifiable set of prefixes 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