com.ibm.commerce.foundation.server.command

Class GenericCommandKeyImpl

  • java.lang.Object
    • com.ibm.commerce.foundation.server.command.GenericCommandKeyImpl
  • All Implemented Interfaces:
    CommandKey

    public class GenericCommandKeyImpl
extends java.lang.Object
implements CommandKey
    The command key used by the command factory whenever anything besides a command key is used to create an instance of the command.

    • Constructor Summary

      Constructors 
      Constructor and Description
      GenericCommandKeyImpl(java.lang.String interfaceName)
      Creates an instance of the generic command key.
      GenericCommandKeyImpl(java.lang.String interfaceName, java.lang.String key)
      Creates an instance of the generic command key.
      GenericCommandKeyImpl(java.lang.String interfaceName, java.lang.String key, boolean useDefaultImpl)
      Creates an instance of the generic command key.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean getDefaultImplementation()
      This method returns whether or not the default implementation should be instantiated if the key has been specified.
      java.lang.String getInterface()
      This method always returns the interface name specified in the constructor.
      java.lang.String getKey()
      This method return the specified key in the constructor.
      java.lang.String toString()
      This method returns the string representation of the object for debugging purposes.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • GenericCommandKeyImpl

        public GenericCommandKeyImpl(java.lang.String interfaceName)
        Creates an instance of the generic command key.
        Parameters:
        interfaceName - The interface name of the target command.

      • GenericCommandKeyImpl

        public GenericCommandKeyImpl(java.lang.String interfaceName,
                             java.lang.String key)
        Creates an instance of the generic command key.
        Parameters:
        interfaceName - The interface name of the target command .
        key - The optional info for the command key.(ex. Xpath and AccessProfile)

      • GenericCommandKeyImpl

        public GenericCommandKeyImpl(java.lang.String interfaceName,
                             java.lang.String key,
                             boolean useDefaultImpl)
        Creates an instance of the generic command key.
        Parameters:
        interfaceName - The interface name of the target command .
        key - The optional info for the command key.(ex. Xpath and AccessProfile)
        useDefaultImpl - Whether to use the default implementation if the key implementation cannot be resolved.

    • Method Detail

      • getInterface

        public java.lang.String getInterface()
        This method always returns the interface name specified in the constructor.
        Specified by:
        getInterface in interface CommandKey
        Returns:
        The interface name associated with the command key.
        See Also:
        CommandKey.getInterface()

      • getKey

        public java.lang.String getKey()
        This method return the specified key in the constructor.
        Specified by:
        getKey in interface CommandKey
        Returns:
        The key specified in the constructor.
        See Also:
        CommandKey.getKey()

      • getDefaultImplementation

        public boolean getDefaultImplementation()
        This method returns whether or not the default implementation should be instantiated if the key has been specified. A value of true means that the default implementation is resolved if the key implementation cannot be resolved. A value of false will indicate that the null is returned if the key implementation has not been found.
        Specified by:
        getDefaultImplementation in interface CommandKey
        Returns:
        Whether or not that the default implementation can be returned in the case where the key is specified and no implementation can be found.

      • toString

        public java.lang.String toString()
        This method returns the string representation of the object for debugging purposes.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The string representation of the object.
Skip navigation links