Class UserMacroConfig

  • All Implemented Interfaces:
    Serializable

    public class UserMacroConfig
    extends Object
    implements Serializable
    Defines a user macro. This gets serialized by Bandana, so don't put any complex objects in it.
    See Also:
    Serialized Form
    • Constructor Detail

      • UserMacroConfig

        public UserMacroConfig()
    • Method Detail

      • getName

        public String getName()
        Returns:
        the name of the macro, always lower-case.
      • setName

        public void setName​(String name)
        Sets the name of the macro, converting to lower-case first.
      • getTemplate

        public String getTemplate()
      • setTemplate

        public void setTemplate​(String template)
      • isHasBody

        public boolean isHasBody()
      • setHasBody

        public void setHasBody​(boolean hasBody)
      • getOutputType

        @Deprecated
        public String getOutputType()
        Deprecated.
        since 4.0. There will be only one output type of HTML beyond 4.0.
      • setOutputType

        @Deprecated
        public void setOutputType​(String outputType)
        Deprecated.
        since 4.0. There will be only one output type of HTML beyond 4.0.
        Parameters:
        outputType -
      • getBodyType

        public String getBodyType()
      • setBodyType

        public void setBodyType​(String bodyType)
      • getTitle

        public String getTitle()
      • setTitle

        public void setTitle​(String title)
      • getDescription

        public String getDescription()
      • setDescription

        public void setDescription​(String description)
      • getCategories

        public Set<String> getCategories()
      • setCategories

        public void setCategories​(Set<String> categories)
      • getIconLocation

        public String getIconLocation()
      • setIconLocation

        public void setIconLocation​(String iconLocation)
      • getDocumentationUrl

        public String getDocumentationUrl()
      • setDocumentationUrl

        public void setDocumentationUrl​(String documentationUrl)
      • isHidden

        public boolean isHidden()
      • setHidden

        public void setHidden​(boolean hidden)
      • toMacro

        public Macro toMacro()