Package org.opencms.setup

Class CmsSetupComponent

  • public class CmsSetupComponent
extends java.lang.Object
    Module group data.

    Since:
    7.0.4

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.String> getDependencies()
      Returns the dependencies.
      java.lang.String getDescription()
      Returns the description.
      java.lang.String getId()
      Returns the id.
      java.util.regex.Pattern getModulesRegex()
      Returns the modules regular expression.
      java.lang.String getName()
      Returns the name.
      int getPosition()
      Returns the position.
      boolean isChecked()
      Checks if checked by default.
      boolean match​(java.lang.String module)
      Matches the module regular expression against the given module name.
      void setChecked​(boolean checked)
      Sets if checked by default.
      void setDependencies​(java.util.List<java.lang.String> dependencies)
      Sets the dependencies.
      void setDescription​(java.lang.String description)
      Sets the description.
      void setId​(java.lang.String id)
      Sets the id.
      void setModulesRegex​(java.lang.String regex)
      Sets the modules regular expression.
      void setName​(java.lang.String name)
      Sets the name.
      void setPosition​(int position)
      Sets the position.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getDependencies

        public java.util.List<java.lang.String> getDependencies()
        Returns the dependencies.

        Returns:
        the dependencies

      • getDescription

        public java.lang.String getDescription()
        Returns the description.

        Returns:
        the description

      • getId

        public java.lang.String getId()
        Returns the id.

        Returns:
        the id

      • getModulesRegex

        public java.util.regex.Pattern getModulesRegex()
        Returns the modules regular expression.

        Returns:
        the modules regular expression

      • getName

        public java.lang.String getName()
        Returns the name.

        Returns:
        the name

      • getPosition

        public int getPosition()
        Returns the position.

        Returns:
        the position

      • isChecked

        public boolean isChecked()
        Checks if checked by default.

        Returns:
        if checked by default

      • match

        public boolean match​(java.lang.String module)
        Matches the module regular expression against the given module name.
        Parameters:
        module - the module name to match
        Returns:
        true if it matches

      • setChecked

        public void setChecked​(boolean checked)
        Sets if checked by default.

        Parameters:
        checked - the checked flag to set

      • setDependencies

        public void setDependencies​(java.util.List<java.lang.String> dependencies)
        Sets the dependencies.

        Parameters:
        dependencies - the dependencies to set

      • setDescription

        public void setDescription​(java.lang.String description)
        Sets the description.

        Parameters:
        description - the description to set

      • setId

        public void setId​(java.lang.String id)
        Sets the id.

        Parameters:
        id - the id to set

      • setModulesRegex

        public void setModulesRegex​(java.lang.String regex)
        Sets the modules regular expression.

        Parameters:
        regex - the regular expression to set

      • setName

        public void setName​(java.lang.String name)
        Sets the name.

        Parameters:
        name - the name to set

      • setPosition

        public void setPosition​(int position)
        Sets the position.

        Parameters:
        position - the position to set

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()