org.apache.commons.vfs2.util

Class URIBitSets

java.lang.Object

org.apache.commons.vfs2.util.URIBitSets

class URIBitSets
extends java.lang.Object

Internal URI encoding BitSet definitions.

This was forked from the BitSets in org.apache.commons.httpclient.URI, in order to not be dependent on HttpClient v3 API, when generating and handling GenericURLFileNames, but it should work with any different HTTP backend provider implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.BitSet	abs_path URI absolute path.
protected static java.util.BitSet	absoluteURI BitSet for absoluteURI.
static java.util.BitSet	allowed_abs_path Those characters that are allowed for the abs_path.
static java.util.BitSet	allowed_authority Those characters that are allowed for the authority component.
static java.util.BitSet	allowed_fragment Those characters that are allowed for the fragment component.
static java.util.BitSet	allowed_host Those characters that are allowed for the host component.
static java.util.BitSet	allowed_IPv6reference Those characters that are allowed for the IPv6reference component.
static java.util.BitSet	allowed_opaque_part Those characters that are allowed for the opaque_part.
static java.util.BitSet	allowed_query Those characters that are allowed for the query component.
static java.util.BitSet	allowed_reg_name Those characters that are allowed for the reg_name.
static java.util.BitSet	allowed_rel_path Those characters that are allowed for the rel_path.
static java.util.BitSet	allowed_userinfo Those characters that are allowed for the userinfo component.
static java.util.BitSet	allowed_within_authority Those characters that are allowed for the authority component.
static java.util.BitSet	allowed_within_path Those characters that are allowed within the path.
static java.util.BitSet	allowed_within_query Those characters that are allowed within the query component.
static java.util.BitSet	allowed_within_userinfo Those characters that are allowed for within the userinfo component.
protected static java.util.BitSet	alpha BitSet for alpha.
protected static java.util.BitSet	alphanum BitSet for alphanum (join of alpha & digit).
protected static java.util.BitSet	authority BitSet for authority.
static java.util.BitSet	control BitSet for control.
static java.util.BitSet	delims BitSet for delims.
protected static java.util.BitSet	digit BitSet for digit.
static java.util.BitSet	disallowed_opaque_part Disallowed opaque_part before escaping.
static java.util.BitSet	disallowed_rel_path Disallowed rel_path before escaping.
protected static java.util.BitSet	domainlabel BitSet for domainlabel.
protected static java.util.BitSet	escaped BitSet for escaped.
protected static java.util.BitSet	fragment BitSet for fragment (alias for uric).
protected static java.util.BitSet	hex BitSet for hex.
protected static java.util.BitSet	hier_part BitSet for hier_part.
protected static java.util.BitSet	host BitSet for host.
protected static java.util.BitSet	hostname BitSet for hostname.
protected static java.util.BitSet	hostport BitSet for hostport.
protected static java.util.BitSet	IPv4address Bitset that combines digit and dot fo IPv$address.
protected static java.util.BitSet	IPv6address RFC 2373.
protected static java.util.BitSet	IPv6reference RFC 2732, 2373.
protected static java.util.BitSet	mark BitSet for mark.
protected static java.util.BitSet	net_path BitSet for net_path.
protected static java.util.BitSet	opaque_part URI bitset that combines uric_no_slash and uric.
protected static java.util.BitSet	param BitSet for param (alias for pchar).
protected static java.util.BitSet	path URI bitset that combines absolute path and opaque part.
protected static java.util.BitSet	path_segments BitSet for path segments.
protected static java.util.BitSet	pchar BitSet for pchar.
protected static java.util.BitSet	percent The percent "%" character always has the reserved purpose of being the escape indicator, it must be escaped as "%25" in order to be used as data within a URI.
protected static java.util.BitSet	port Port, a logical alias for digit.
protected static java.util.BitSet	query BitSet for query (alias for uric).
protected static java.util.BitSet	reg_name BitSet for reg_name.
protected static java.util.BitSet	rel_path BitSet for rel_path.
protected static java.util.BitSet	rel_segment BitSet for rel_segment.
protected static java.util.BitSet	relativeURI BitSet for relativeURI.
protected static java.util.BitSet	reserved BitSet for reserved.
protected static java.util.BitSet	scheme BitSet for scheme.
protected static java.util.BitSet	segment BitSet for segment.
protected static java.util.BitSet	server Bitset for server.
static java.util.BitSet	space BitSet for space.
protected static java.util.BitSet	toplabel BitSet for toplabel.
protected static java.util.BitSet	unreserved Data characters that are allowed in a URI but do not have a reserved purpose are called unreserved.
static java.util.BitSet	unwise BitSet for unwise.
protected static java.util.BitSet	URI_reference BitSet for URI-reference.
protected static java.util.BitSet	uric BitSet for uric.
protected static java.util.BitSet	uric_no_slash URI bitset for encoding typical non-slash characters.
protected static java.util.BitSet	userinfo Bitset for userinfo.
static java.util.BitSet	within_userinfo BitSet for within the userinfo component like user and password.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	URIBitSets()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

percent

protected static final java.util.BitSet percent

The percent "%" character always has the reserved purpose of being the escape indicator, it must be escaped as "%25" in order to be used as data within a URI.

digit

protected static final java.util.BitSet digit

BitSet for digit.

 digit    = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" |
            "8" | "9"
 

alpha

protected static final java.util.BitSet alpha

BitSet for alpha.

 alpha         = lowalpha | upalpha
 

alphanum

protected static final java.util.BitSet alphanum

BitSet for alphanum (join of alpha & digit).

  alphanum      = alpha | digit
 

hex

protected static final java.util.BitSet hex

BitSet for hex.

 hex           = digit | "A" | "B" | "C" | "D" | "E" | "F" |
                         "a" | "b" | "c" | "d" | "e" | "f"
 

escaped

protected static final java.util.BitSet escaped

BitSet for escaped.

 escaped       = "%" hex hex
 

mark

protected static final java.util.BitSet mark

BitSet for mark.

 mark          = "-" | "_" | "." | "!" | "~" | "*" | "'" |
                 "(" | ")"
 

unreserved

protected static final java.util.BitSet unreserved

Data characters that are allowed in a URI but do not have a reserved purpose are called unreserved.

 unreserved    = alphanum | mark
 

reserved

protected static final java.util.BitSet reserved

BitSet for reserved.

 reserved      = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
                 "$" | ","
 

uric

protected static final java.util.BitSet uric

BitSet for uric.

 uric          = reserved | unreserved | escaped
 

fragment

protected static final java.util.BitSet fragment

BitSet for fragment (alias for uric).

 fragment      = *uric
 

query

protected static final java.util.BitSet query

BitSet for query (alias for uric).

 query         = *uric
 

pchar

protected static final java.util.BitSet pchar

BitSet for pchar.

 pchar         = unreserved | escaped |
                 ":" | "@" | "&" | "=" | "+" | "$" | ","
 

param

protected static final java.util.BitSet param

BitSet for param (alias for pchar).

 param         = *pchar
 

segment

protected static final java.util.BitSet segment

BitSet for segment.

 segment       = *pchar *( ";" param )
 

path_segments

protected static final java.util.BitSet path_segments

BitSet for path segments.

 path_segments = segment *( "/" segment )
 

abs_path

protected static final java.util.BitSet abs_path

URI absolute path.

 abs_path      = "/"  path_segments
 

uric_no_slash

protected static final java.util.BitSet uric_no_slash

URI bitset for encoding typical non-slash characters.

 uric_no_slash = unreserved | escaped | ";" | "?" | ":" | "@" |
                 "&" | "=" | "+" | "$" | ","
 

opaque_part

protected static final java.util.BitSet opaque_part

URI bitset that combines uric_no_slash and uric.

 opaque_part   = uric_no_slash *uric
 

path

protected static final java.util.BitSet path

URI bitset that combines absolute path and opaque part.

 path          = [ abs_path | opaque_part ]
 

port

protected static final java.util.BitSet port

Port, a logical alias for digit.

IPv4address

protected static final java.util.BitSet IPv4address

Bitset that combines digit and dot fo IPv$address.

 IPv4address   = 1*digit "." 1*digit "." 1*digit "." 1*digit
 

IPv6address

protected static final java.util.BitSet IPv6address

RFC 2373.

 IPv6address = hexpart [ ":" IPv4address ]
 

IPv6reference

protected static final java.util.BitSet IPv6reference

RFC 2732, 2373.

 IPv6reference   = "[" IPv6address "]"
 

toplabel

protected static final java.util.BitSet toplabel

BitSet for toplabel.

 toplabel      = alpha | alpha *( alphanum | "-" ) alphanum
 

domainlabel

protected static final java.util.BitSet domainlabel

BitSet for domainlabel.

 domainlabel   = alphanum | alphanum *( alphanum | "-" ) alphanum
 

hostname

protected static final java.util.BitSet hostname

BitSet for hostname.

 hostname      = *( domainlabel "." ) toplabel [ "." ]
 

host

protected static final java.util.BitSet host

BitSet for host.

 host          = hostname | IPv4address | IPv6reference
 

hostport

protected static final java.util.BitSet hostport

BitSet for hostport.

 hostport      = host [ ":" port ]
 

userinfo

protected static final java.util.BitSet userinfo

Bitset for userinfo.

 userinfo      = *( unreserved | escaped |
                    ";" | ":" | "&" | "=" | "+" | "$" | "," )
 

within_userinfo

public static final java.util.BitSet within_userinfo

BitSet for within the userinfo component like user and password.

server

protected static final java.util.BitSet server

Bitset for server.

 server        = [ [ userinfo "@" ] hostport ]
 

reg_name

protected static final java.util.BitSet reg_name

BitSet for reg_name.

 reg_name      = 1*( unreserved | escaped | "$" | "," |
                     ";" | ":" | "@" | "&" | "=" | "+" )
 

authority

protected static final java.util.BitSet authority

BitSet for authority.

 authority     = server | reg_name
 

scheme

protected static final java.util.BitSet scheme

BitSet for scheme.

 scheme        = alpha *( alpha | digit | "+" | "-" | "." )
 

rel_segment

protected static final java.util.BitSet rel_segment

BitSet for rel_segment.

 rel_segment   = 1*( unreserved | escaped |
                     ";" | "@" | "&" | "=" | "+" | "$" | "," )
 

rel_path

protected static final java.util.BitSet rel_path

BitSet for rel_path.

 rel_path      = rel_segment [ abs_path ]
 

net_path

protected static final java.util.BitSet net_path

BitSet for net_path.

 net_path      = "//" authority [ abs_path ]
 

hier_part

protected static final java.util.BitSet hier_part

BitSet for hier_part.

 hier_part     = ( net_path | abs_path ) [ "?" query ]
 

relativeURI

protected static final java.util.BitSet relativeURI

BitSet for relativeURI.

 relativeURI   = ( net_path | abs_path | rel_path ) [ "?" query ]
 

absoluteURI

protected static final java.util.BitSet absoluteURI

BitSet for absoluteURI.

 absoluteURI   = scheme ":" ( hier_part | opaque_part )
 

URI_reference

protected static final java.util.BitSet URI_reference

BitSet for URI-reference.

 URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]
 

control

public static final java.util.BitSet control

BitSet for control.

space

public static final java.util.BitSet space

BitSet for space.

delims

public static final java.util.BitSet delims

BitSet for delims.

unwise

public static final java.util.BitSet unwise

BitSet for unwise.

disallowed_rel_path

public static final java.util.BitSet disallowed_rel_path

Disallowed rel_path before escaping.

disallowed_opaque_part

public static final java.util.BitSet disallowed_opaque_part

Disallowed opaque_part before escaping.

allowed_authority

public static final java.util.BitSet allowed_authority

Those characters that are allowed for the authority component.

allowed_opaque_part

public static final java.util.BitSet allowed_opaque_part

Those characters that are allowed for the opaque_part.

allowed_reg_name

public static final java.util.BitSet allowed_reg_name

Those characters that are allowed for the reg_name.

allowed_userinfo

public static final java.util.BitSet allowed_userinfo

Those characters that are allowed for the userinfo component.

allowed_within_userinfo

public static final java.util.BitSet allowed_within_userinfo

Those characters that are allowed for within the userinfo component.

allowed_IPv6reference

public static final java.util.BitSet allowed_IPv6reference

Those characters that are allowed for the IPv6reference component. The characters '[', ']' in IPv6reference should be excluded.

allowed_host

public static final java.util.BitSet allowed_host

Those characters that are allowed for the host component. The characters '[', ']' in IPv6reference should be excluded.

allowed_within_authority

public static final java.util.BitSet allowed_within_authority

Those characters that are allowed for the authority component.

allowed_abs_path

public static final java.util.BitSet allowed_abs_path

Those characters that are allowed for the abs_path.

allowed_rel_path

public static final java.util.BitSet allowed_rel_path

Those characters that are allowed for the rel_path.

allowed_within_path

public static final java.util.BitSet allowed_within_path

Those characters that are allowed within the path.

allowed_query

public static final java.util.BitSet allowed_query

Those characters that are allowed for the query component.

allowed_within_query

public static final java.util.BitSet allowed_within_query

Those characters that are allowed within the query component.

allowed_fragment

public static final java.util.BitSet allowed_fragment

Those characters that are allowed for the fragment component.

Constructor Detail

URIBitSets

private URIBitSets()