APIdia Launch Partner
Top Description Inners Fields Constructors Methods
javax.xml.catalog

pack-priv abstract Class BaseEntry

extends Object
Class Inheritance
Known Direct Subclasses
javax.xml.catalog.GroupEntry, javax.xml.catalog.PublicEntry, javax.xml.catalog.RewriteSystem, javax.xml.catalog.RewriteUri, javax.xml.catalog.SystemEntry, javax.xml.catalog.SystemSuffix, javax.xml.catalog.UriEntry, javax.xml.catalog.UriSuffix, javax.xml.catalog.AltCatalog
Imports
java.net.MalformedURLException, .URL, java.util.Objects

Represents a general Catalog entry.
Since
9

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static enum
BaseEntry.CatalogEntryType

CatalogEntryType represents catalog entry types.

Field Summary

Modifier and TypeField and Description
pack-priv boolean
pack-priv URL
pack-priv String
pack-priv String
pack-priv final String
pack-priv BaseEntry.CatalogEntryType

Constructor Summary

AccessConstructor and Description
public
BaseEntry(BaseEntry.CatalogEntryType
The type of the entry
type
)

Constructs a CatalogEntry

public
BaseEntry(BaseEntry.CatalogEntryType
The type of the entry
type
,
String
The base URI
base
)

Constructs a CatalogEntry

Method Summary

Modifier and TypeMethod and Description
public URL

Returns:

The base URI as a string.
getBaseURI
()

Gets the base URI for the entry

public String

Returns:

The id of the entry
getId
()

Returns the id of the entry

public String

Returns:

The value of the field
getMatchId
()

Gets the attribute used for matching

public BaseEntry.CatalogEntryType

Returns:

The type of the entry
getType
()

Returns the type of the entry

public String

Returns:

The replacement URI if a matching entry is found, null if not.
match
(String
The identifier attribute to be matched
match
)

Matches the specified string with the identifier attribute of the entry.

public String

Returns:

The replacement URI if the match is successful, null if not.
match
(String
The id to be matched.
id
,
int
The length of start String of previous match if any.
currentMatch
)

Try to match the specified id with the entry.

public final void
setBaseURI(String
The base URI
base
)

Sets the base URI for the entry

public void
setId(String
The Id attribute
id
)

Set the entry Id

public void
setMatchId(String
The value of the Id
matchId
)

Sets the matchId field

public void
setType(BaseEntry.CatalogEntryType
The entry type
type
)

Sets the entry type

pack-priv URL

Returns:

The URI created from the specified uri
verifyURI
(String
The name of the argument
arg
,
URL base, String
The URI to be verified
uri
)

Verifies the specified URI.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

baseSpecifiedback to summary
pack-priv boolean baseSpecified
baseURIback to summary
pack-priv URL baseURI
idback to summary
pack-priv String id
matchIdback to summary
pack-priv String matchId
SLASHback to summary
pack-priv final String SLASH
typeback to summary
pack-priv BaseEntry.CatalogEntryType type

Constructor Detail

BaseEntryback to summary
public BaseEntry(BaseEntry.CatalogEntryType type)

Constructs a CatalogEntry

Parameters
type:BaseEntry.CatalogEntryType

The type of the entry

BaseEntryback to summary
public BaseEntry(BaseEntry.CatalogEntryType type, String base)

Constructs a CatalogEntry

Parameters
type:BaseEntry.CatalogEntryType

The type of the entry

base:String

The base URI

Method Detail

getBaseURIback to summary
public URL getBaseURI()

Gets the base URI for the entry

Returns:URL

The base URI as a string.

getIdback to summary
public String getId()

Returns the id of the entry

Returns:String

The id of the entry

getMatchIdback to summary
public String getMatchId()

Gets the attribute used for matching

Returns:String

The value of the field

getTypeback to summary
public BaseEntry.CatalogEntryType getType()

Returns the type of the entry

Returns:BaseEntry.CatalogEntryType

The type of the entry

matchback to summary
public String match(String match)

Matches the specified string with the identifier attribute of the entry.

Parameters
match:String

The identifier attribute to be matched

Returns:String

The replacement URI if a matching entry is found, null if not.

matchback to summary
public String match(String id, int currentMatch)

Try to match the specified id with the entry. Return the match if it is successful and the length of the start String is longer than the longest of any previous match.

Parameters
id:String

The id to be matched.

currentMatch:int

The length of start String of previous match if any.

Returns:String

The replacement URI if the match is successful, null if not.

setBaseURIback to summary
public final void setBaseURI(String base)

Sets the base URI for the entry

Parameters
base:String

The base URI

setIdback to summary
public void setId(String id)

Set the entry Id

Parameters
id:String

The Id attribute

setMatchIdback to summary
public void setMatchId(String matchId)

Sets the matchId field

Parameters
matchId:String

The value of the Id

setTypeback to summary
public void setType(BaseEntry.CatalogEntryType type)

Sets the entry type

Parameters
type:BaseEntry.CatalogEntryType

The entry type

verifyURIback to summary
pack-priv URL verifyURI(String arg, URL base, String uri)

Verifies the specified URI.

Parameters
arg:String

The name of the argument

uri:String

The URI to be verified

Returns:URL

The URI created from the specified uri

Exceptions
NullPointerException:
if the specified uri is null
IllegalArgumentException:
if a URL can not be created based on the specified base and uri
javax.xml.catalog back to summary

pack-priv final Enum BaseEntry.CatalogEntryType

extends Enum<BaseEntry.CatalogEntryType>
Class Inheritance

CatalogEntryType represents catalog entry types.

Field Summary

Modifier and TypeField and Description
public static final BaseEntry.CatalogEntryType
public static final BaseEntry.CatalogEntryType
public static final BaseEntry.CatalogEntryType
public static final BaseEntry.CatalogEntryType
public static final BaseEntry.CatalogEntryType
public static final BaseEntry.CatalogEntryType
pack-priv final String
public static final BaseEntry.CatalogEntryType
public static final BaseEntry.CatalogEntryType
public static final BaseEntry.CatalogEntryType
public static final BaseEntry.CatalogEntryType
public static final BaseEntry.CatalogEntryType
public static final BaseEntry.CatalogEntryType
public static final BaseEntry.CatalogEntryType
public static final BaseEntry.CatalogEntryType

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static BaseEntry.CatalogEntryType
getType(String entryType)

public boolean
isType(String type)

public static BaseEntry.CatalogEntryType
public static BaseEntry.CatalogEntryType[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CATALOGback to summary
public static final BaseEntry.CatalogEntryType CATALOG
CATALOGENTRYback to summary
public static final BaseEntry.CatalogEntryType CATALOGENTRY
DELEGATEPUBLICback to summary
public static final BaseEntry.CatalogEntryType DELEGATEPUBLIC
DELEGATESYSTEMback to summary
public static final BaseEntry.CatalogEntryType DELEGATESYSTEM
DELEGATEURIback to summary
public static final BaseEntry.CatalogEntryType DELEGATEURI
GROUPback to summary
public static final BaseEntry.CatalogEntryType GROUP
literalback to summary
pack-priv final String literal
NEXTCATALOGback to summary
public static final BaseEntry.CatalogEntryType NEXTCATALOG
PUBLICback to summary
public static final BaseEntry.CatalogEntryType PUBLIC
REWRITESYSTEMback to summary
public static final BaseEntry.CatalogEntryType REWRITESYSTEM
REWRITEURIback to summary
public static final BaseEntry.CatalogEntryType REWRITEURI
SYSTEMback to summary
public static final BaseEntry.CatalogEntryType SYSTEM
SYSTEMSUFFIXback to summary
public static final BaseEntry.CatalogEntryType SYSTEMSUFFIX
URIback to summary
public static final BaseEntry.CatalogEntryType URI
URISUFFIXback to summary
public static final BaseEntry.CatalogEntryType URISUFFIX

Constructor Detail

CatalogEntryTypeback to summary
private CatalogEntryType(String literal)

Method Detail

getTypeback to summary
public static BaseEntry.CatalogEntryType getType(String entryType)
isTypeback to summary
public boolean isType(String type)
valueOfback to summary
public static BaseEntry.CatalogEntryType valueOf(String name)
valuesback to summary
public static BaseEntry.CatalogEntryType[] values()