com.ibm.wsspi.anno.util
Interface Util_InternMap


public interface Util_InternMap


Nested Class Summary
static class Util_InternMap.ValueType
           
 
Field Summary
static boolean DO_FORCE
           
static boolean DO_NOT_FORCE
           
 
Method Summary
 boolean contains(java.lang.String name)
           
 Util_Factory getFactory()
           
 java.lang.String getHashText()
           
 int getLogThreshHold()
           
 java.lang.String getName()
           
 int getSize()
           
 int getTotalLength()
           
 java.util.Collection<java.lang.String> getValues()
           
 Util_InternMap.ValueType getValueType()
           
 java.lang.String intern(java.lang.String name)
           
 java.lang.String intern(java.lang.String name, boolean doForce)
           
 void log(com.ibm.websphere.ras.TraceComponent tc)
           
 void logState()
           
 java.lang.String validate(java.lang.String value, Util_InternMap.ValueType valueType)
          Check the input value for syntax errors based on the type of value.
 

Field Detail

DO_FORCE

static final boolean DO_FORCE
See Also:
Constant Field Values

DO_NOT_FORCE

static final boolean DO_NOT_FORCE
See Also:
Constant Field Values
Method Detail

getHashText

java.lang.String getHashText()

getLogThreshHold

int getLogThreshHold()

logState

void logState()

log

void log(com.ibm.websphere.ras.TraceComponent tc)

getFactory

Util_Factory getFactory()

getName

java.lang.String getName()

validate

java.lang.String validate(java.lang.String value,
                          Util_InternMap.ValueType valueType)
Check the input value for syntax errors based on the type of value.

The validate method will return a message key as the string if a validation error is found. The message key should exist in the NLS resource bundle used by the caller. The message key can then be passed to com.ibm.websphere.ras.Tr along with any substitution parameters for display in the log file.

Parameters:
value - a String that contains the value to be validated
valueType - a ValueType that identifies the type of 'value'
Returns:
String if 'value' contains an error, return the message key to the corresponding error message from the resource bundle, else return 'null'.

getValueType

Util_InternMap.ValueType getValueType()

getValues

java.util.Collection<java.lang.String> getValues()

getSize

int getSize()

getTotalLength

int getTotalLength()

contains

boolean contains(java.lang.String name)

intern

java.lang.String intern(java.lang.String name)

intern

java.lang.String intern(java.lang.String name,
                        boolean doForce)