public class DictionaryFQN extends java.lang.Object implements java.lang.Comparable<DictionaryFQN>, java.io.Serializable
Each property must be a Unicode identifier as defined by the
isUnicodeIdentifierStart
and
isUnicodeIdentifierPart
methods in
java.lang.Character
.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EXTENSION
The extension used for rule dictionaries.
|
Constructor and Description |
---|
DictionaryFQN(java.lang.String pkg,
java.lang.String name)
Construct a fully qualified name of a dictionary.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
asPath()
Returns the relative path representation of this fully qualified name.
|
int |
compareTo(DictionaryFQN fqn)
Compares this DictionaryFQN with the specified DictionaryFQN.
|
static DictionaryFQN |
createDictionaryFQN(java.lang.String pkg,
java.lang.String name)
Create a fully qualified name of a dictionary.
|
boolean |
equals(java.lang.Object obj)
Indicates whether this DictionaryFQN is equal to another object
|
java.lang.String |
getName()
Returns the name of the dictionary
|
java.lang.String |
getPackage()
Returns the dictionary package
|
static boolean |
isNameValid(java.lang.String name)
Checks if the dictionary name is valid
|
static boolean |
isPackageValid(java.lang.String pkg)
Checks if the dictionary package is valid
|
void |
validateForAccess()
Check validity of this fully qualified name for dictionary access.
|
void |
validateForGetNames()
Check validity of this fully qualified name for use with
getNames . |
public static final java.lang.String EXTENSION
public DictionaryFQN(java.lang.String pkg, java.lang.String name)
pkg
- the dictionary packagename
- the dictionary namepublic static DictionaryFQN createDictionaryFQN(java.lang.String pkg, java.lang.String name)
pkg
- the dictionary packagename
- the dictionary namepublic java.lang.String asPath()
public java.lang.String getPackage()
public java.lang.String getName()
public void validateForAccess() throws InvalidFQNException
InvalidFQNException
- if this fully qualified name is invalidpublic void validateForGetNames() throws InvalidFQNException
getNames
.InvalidFQNException
- if this fully qualified name is invalidpublic static boolean isPackageValid(java.lang.String pkg)
pkg
- the dictionary package to validatepublic static boolean isNameValid(java.lang.String name)
name
- the dictionary name to validatepublic int compareTo(DictionaryFQN fqn)
compareTo
in interface java.lang.Comparable<DictionaryFQN>
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object