org.opends.messages
Class MessageDescriptor.ArgN

java.lang.Object
  extended by org.opends.messages.MessageDescriptor
      extended by org.opends.messages.MessageDescriptor.ArgN
Enclosing class:
MessageDescriptor

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=true,
           mayExtend=false,
           mayInvoke=true)
public static final class MessageDescriptor.ArgN
extends MessageDescriptor

Subclass for creating messages with an any number of arguments. In general this class should be used when a message needs to be defined with more arguments that can be handled with the current number of subclasses


Nested Class Summary
 
Nested classes/interfaces inherited from class org.opends.messages.MessageDescriptor
MessageDescriptor.Arg0, MessageDescriptor.Arg1<T1>, MessageDescriptor.Arg10<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>, MessageDescriptor.Arg11<T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>, MessageDescriptor.Arg2<T1,T2>, MessageDescriptor.Arg3<T1,T2,T3>, MessageDescriptor.Arg4<T1,T2,T3,T4>, MessageDescriptor.Arg5<T1,T2,T3,T4,T5>, MessageDescriptor.Arg6<T1,T2,T3,T4,T5,T6>, MessageDescriptor.Arg7<T1,T2,T3,T4,T5,T6,T7>, MessageDescriptor.Arg8<T1,T2,T3,T4,T5,T6,T7,T8>, MessageDescriptor.Arg9<T1,T2,T3,T4,T5,T6,T7,T8,T9>, MessageDescriptor.ArgN
 
Field Summary
 
Fields inherited from class org.opends.messages.MessageDescriptor
DESCRIPTOR_CLASS_BASE_NAME, DESCRIPTOR_MAX_ARG_HANDLER, NULL_ID
 
Constructor Summary
MessageDescriptor.ArgN(java.lang.String rbBase, java.lang.String key, Category category, Severity severity, int ordinal, java.lang.ClassLoader classLoader)
          Creates a parameterized instance.
MessageDescriptor.ArgN(java.lang.String rbBase, java.lang.String key, int mask, Severity severity, int ordinal, java.lang.ClassLoader classLoader)
          Creates a parameterized instance.
 
Method Summary
 Message get(java.lang.Object... args)
          Creates a message with arguments that will replace format specifiers in the assocated format string when the message is rendered to string representation.
 
Methods inherited from class org.opends.messages.MessageDescriptor
containsArgumentLiterals, getBase, getCategory, getId, getKey, getMask, getOrdinal, getSeverity
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MessageDescriptor.ArgN

public MessageDescriptor.ArgN(java.lang.String rbBase,
                              java.lang.String key,
                              Category category,
                              Severity severity,
                              int ordinal,
                              java.lang.ClassLoader classLoader)
Creates a parameterized instance.

Parameters:
rbBase - base of the backing resource bundle
key - for accessing the format string from the resource bundle
category - of created messages
severity - of created messages
ordinal - of created messages
classLoader - the class loader to be used to get the ResourceBundle

MessageDescriptor.ArgN

public MessageDescriptor.ArgN(java.lang.String rbBase,
                              java.lang.String key,
                              int mask,
                              Severity severity,
                              int ordinal,
                              java.lang.ClassLoader classLoader)
Creates a parameterized instance.

Parameters:
rbBase - base of the backing resource bundle
key - for accessing the format string from the resource bundle
mask - to apply to the USER_DEFINED category
severity - of created messages
ordinal - of created messages
classLoader - the class loader to be used to get the ResourceBundle
Method Detail

get

public Message get(java.lang.Object... args)
Creates a message with arguments that will replace format specifiers in the assocated format string when the message is rendered to string representation.

Parameters:
args - message arguments
Returns:
Message object