Package com.hybris.cockpitng.core.context

Interface CockpitContext

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default void addAllParameters​(CockpitContext context)
      Adds all parameters stored in given context
      void clearParameters()
      Clears all parameters
      boolean containsParameter​(java.lang.String key)
      Checks if given parameter exists
      java.lang.Object getParameter​(java.lang.String key)
      Gets single parameter
      default boolean getParameterAsBoolean​(java.lang.String key, boolean defaultValue)
      Returns a boolean representation of the object stored under the given key or default value if the object is null.
      java.util.Set<java.lang.String> getParameterKeys()
      Gets keys of the parameters
      java.util.Map<java.lang.String,​java.lang.Object> getParameters()
      Returns map of parameters
      void removeParameter​(java.lang.String key)
      Removes single parameter with specified key
      void setParameter​(java.lang.String key, java.lang.Object value)
      Sets single parameter
      void setParameters​(java.util.Map<java.lang.String,​java.lang.Object> parameters)
      Sets map of parameters

    • Method Detail

      • getParameters

        java.util.Map<java.lang.String,​java.lang.Object> getParameters()
        Returns map of parameters
        Returns:
        parameters

      • setParameters

        void setParameters​(java.util.Map<java.lang.String,​java.lang.Object> parameters)
        Sets map of parameters
        Parameters:
        parameters -

      • getParameterAsBoolean

        default boolean getParameterAsBoolean​(java.lang.String key,
                                      boolean defaultValue)
        Returns a boolean representation of the object stored under the given key or default value if the object is null.
        Parameters:
        key - parameter key.
        defaultValue - default value if the key is not found in the context or its value is null.
        Returns:
        the boolean representation of the object or the default value.

      • setParameter

        void setParameter​(java.lang.String key,
                  java.lang.Object value)
        Sets single parameter
        Parameters:
        key - parameter key
        value - parameter value

      • getParameter

        java.lang.Object getParameter​(java.lang.String key)
        Gets single parameter
        Parameters:
        key - parameter key
        Returns:
        Object stored under specified key

      • removeParameter

        void removeParameter​(java.lang.String key)
        Removes single parameter with specified key
        Parameters:
        key - parameter key

      • getParameterKeys

        java.util.Set<java.lang.String> getParameterKeys()
        Gets keys of the parameters
        Returns:
        Set containing keys of the parameters

      • containsParameter

        boolean containsParameter​(java.lang.String key)
        Checks if given parameter exists
        Parameters:
        key - parameter key
        Returns:
        Boolean, which is equal to true if parameter exists and is equal to false if not

      • clearParameters

        void clearParameters()
        Clears all parameters

      • addAllParameters

        default void addAllParameters​(CockpitContext context)
        Adds all parameters stored in given context
        Parameters:
        context - source