|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jibx.schema.codegen.extend.DefaultNameConverter
public class DefaultNameConverter
Converter for working with Java names.
Field Summary | |
---|---|
private boolean |
m_camelCase
Camelcase field names flag. |
private java.lang.String |
m_fieldPrefix
Prefix used for normal field names (non- null , may be empty). |
private java.lang.String |
m_fieldSuffix
Suffix used for normal field names (non- null , may be empty). |
private java.lang.String |
m_staticPrefix
Prefix used for static field names (non- null , may be empty). |
private java.lang.String |
m_staticSuffix
Suffix used for static field names (non- null , may be empty). |
private java.lang.String[] |
m_stripPrefixes
Set of XML name prefixes to be discarded in conversions. |
private java.lang.String[] |
m_stripSuffixes
Set of XML name suffixes to be discarded in conversions. |
private boolean |
m_underscore
Use underscores in field names flag (as substitute for special characters, and to split words). |
private boolean |
m_upperInitial
Uppercase initial letter of field names flag. |
private java.util.ArrayList |
m_wordList
Reusable array for words in name. |
Constructor Summary | |
---|---|
DefaultNameConverter()
Constructor. |
|
DefaultNameConverter(DefaultNameConverter base)
Copy constructor. |
Method Summary | |
---|---|
private java.lang.String |
buildFieldName(java.lang.String base,
java.lang.String prefix,
java.lang.String suffix)
Build a field name using supplied prefix and/or suffix. |
java.lang.String |
depluralize(java.lang.String name)
Convert potentially plural name to singular form. |
java.lang.String |
getFieldPrefix()
Get prefix text for normal field names. |
java.lang.String |
getFieldSuffix()
Get suffix text for normal field names. |
java.lang.String |
getStaticPrefix()
Get prefix text for static field names. |
java.lang.String |
getStaticSuffix()
Get suffix text for static field names. |
java.lang.String[] |
getStripPrefixes()
Get the prefixes to be stripped when converting XML names. |
java.lang.String[] |
getStripSuffixes()
Get the suffixes to be stripped when converting XML names. |
protected static boolean |
isConversionNeeded(java.lang.String name)
Check if a name needs to be converted from XML form due to invalid characters or embedded underscores. |
java.lang.String |
pluralize(java.lang.String name)
Convert singular name to plural form. |
void |
setFieldPrefix(java.lang.String pref)
Set prefix text for normal field names. |
void |
setFieldSuffix(java.lang.String suff)
Set suffix text for normal field names. |
void |
setStaticPrefix(java.lang.String pref)
Set prefix text for static field names. |
void |
setStaticSuffix(java.lang.String suff)
Set suffix text for static field names. |
void |
setStripPrefixes(java.lang.String[] prefixes)
Set the prefixes to be stripped when converting XML names. |
void |
setStripSuffixes(java.lang.String[] suffixes)
Set the suffixes to be stripped when converting XML names. |
java.lang.String[] |
splitXMLWords(java.lang.String name)
Split an XML name into words. |
java.lang.String |
toBaseName(java.lang.String xname)
Convert an XML name to a Java value base name. |
java.lang.String |
toConstantName(java.lang.String text)
Convert text to constant name. |
java.lang.String |
toFieldName(java.lang.String base)
Convert base name to normal field name. |
java.lang.String |
toIfSetAccessMethodName(java.lang.String prop)
Convert property name to if set access method name (for value in set of alternatives). |
java.lang.String |
toJavaClassName(java.lang.String name)
Convert a base name to a legal Java class name. |
java.lang.String |
toPropertyName(java.lang.String base)
Convert base name to property name (used for all method names). |
java.lang.String |
toReadAccessMethodName(java.lang.String prop)
Convert property name to read access method name. |
java.lang.String |
toStaticFieldName(java.lang.String base)
Convert base name to static field name. |
java.lang.String |
toTestAccessMethodName(java.lang.String prop)
Convert property name to write access method name. |
java.lang.String |
toWriteAccessMethodName(java.lang.String prop)
Convert property name to write access method name. |
java.lang.String |
trimXName(java.lang.String xname)
Trim specified prefixes and/or suffixes from an XML name. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private boolean m_camelCase
private java.lang.String m_fieldPrefix
null
, may be empty).
private java.lang.String m_fieldSuffix
null
, may be empty).
private java.lang.String m_staticPrefix
null
, may be empty).
private java.lang.String m_staticSuffix
null
, may be empty).
private boolean m_underscore
private boolean m_upperInitial
private java.lang.String[] m_stripPrefixes
private java.lang.String[] m_stripSuffixes
private java.util.ArrayList m_wordList
Constructor Detail |
---|
public DefaultNameConverter()
public DefaultNameConverter(DefaultNameConverter base)
base
- instance used to initialize settingsMethod Detail |
---|
public java.lang.String pluralize(java.lang.String name)
pluralize
in interface NameConverter
name
- base name
public java.lang.String depluralize(java.lang.String name)
depluralize
in interface NameConverter
name
- base name
public java.lang.String getFieldPrefix()
null
, may be empty)public void setFieldPrefix(java.lang.String pref)
pref
- field prefix (non-null
, may be empty)public java.lang.String getFieldSuffix()
null
, may be empty)public void setFieldSuffix(java.lang.String suff)
suff
- field suffix (non-null
, may be empty)public java.lang.String getStaticPrefix()
null
, may be empty)public void setStaticPrefix(java.lang.String pref)
pref
- field prefix (non-null
, may be empty)public java.lang.String getStaticSuffix()
null
, may be empty)public void setStaticSuffix(java.lang.String suff)
suff
- field suffix (non-null
, may be empty)public java.lang.String[] getStripPrefixes()
public void setStripPrefixes(java.lang.String[] prefixes)
prefixes
- public java.lang.String[] getStripSuffixes()
public void setStripSuffixes(java.lang.String[] suffixes)
suffixes
- public java.lang.String trimXName(java.lang.String xname)
trimXName
in interface NameConverter
xname
- XML name
public java.lang.String[] splitXMLWords(java.lang.String name)
splitXMLWords
in interface NameConverter
name
-
protected static boolean isConversionNeeded(java.lang.String name)
name
-
true
if invalid name, false
if validpublic java.lang.String toJavaClassName(java.lang.String name)
java.lang
, to avoid conflicts with the import handling in generated code.
toJavaClassName
in interface NameConverter
name
- base name
public java.lang.String toBaseName(java.lang.String xname)
toBaseName
in interface NameConverter
xname
- XML name
public java.lang.String toConstantName(java.lang.String text)
toConstantName
in interface NameConverter
text
- raw text to be converted
private java.lang.String buildFieldName(java.lang.String base, java.lang.String prefix, java.lang.String suffix)
base
- normalized camelcase base nameprefix
- text to be added at start of namesuffix
- text to be added at end of name
public java.lang.String toFieldName(java.lang.String base)
toFieldName
in interface NameConverter
base
- normalized camelcase base name
public java.lang.String toStaticFieldName(java.lang.String base)
toStaticFieldName
in interface NameConverter
base
- normalized camelcase base name
public java.lang.String toPropertyName(java.lang.String base)
toPropertyName
in interface NameConverter
base
- normalized camelcase base name
public java.lang.String toReadAccessMethodName(java.lang.String prop)
toReadAccessMethodName
in interface NameConverter
prop
- property name in initial-upper camelcase form
public java.lang.String toWriteAccessMethodName(java.lang.String prop)
toWriteAccessMethodName
in interface NameConverter
prop
- property name in initial-upper camelcase form
public java.lang.String toTestAccessMethodName(java.lang.String prop)
toTestAccessMethodName
in interface NameConverter
prop
- property name in initial-upper camelcase form
public java.lang.String toIfSetAccessMethodName(java.lang.String prop)
toIfSetAccessMethodName
in interface NameConverter
prop
- property name in initial-upper camelcase form
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |