Package org.opencms.xml.content

Class CmsChangeHandlerConfig

  • public class CmsChangeHandlerConfig
extends java.lang.Object
    A configuration bean representing a <ChangeHandler> element configured in an XSD's field settings.

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsChangeHandlerConfig​(java.lang.String field, java.lang.String className, java.lang.String config)
      Creates a new instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getClassName()
      Gets the class name for the handler.
      java.lang.String getConfig()
      Gets the configuration string for the handler.
      java.lang.String getField()
      Gets the field name for which the handler is configured.
      java.util.Optional<I_CmsXmlContentEditorChangeHandler> newHandler​(java.lang.String scope)
      Creates a new handler instance using this configuration and the given scope.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CmsChangeHandlerConfig

        public CmsChangeHandlerConfig​(java.lang.String field,
                              java.lang.String className,
                              java.lang.String config)
        Creates a new instance.
        Parameters:
        field - the field name
        className - the handler class name
        config - the configuration string

    • Method Detail

      • getClassName

        public java.lang.String getClassName()
        Gets the class name for the handler.
        Returns:
        the class name

      • getConfig

        public java.lang.String getConfig()
        Gets the configuration string for the handler.
        Returns:
        the configuration string

      • getField

        public java.lang.String getField()
        Gets the field name for which the handler is configured.
        Returns:
        the field name for which the handler is configured

      • newHandler

        public java.util.Optional<I_CmsXmlContentEditorChangeHandler> newHandler​(java.lang.String scope)
        Creates a new handler instance using this configuration and the given scope.
        Parameters:
        scope - the scope
        Returns:
        the new handler instance