Package org.apache.tomcat.util.descriptor.tld

Class TaglibXml

  • public class TaglibXml
extends java.lang.Object
    Common representation of a Tag Library Descriptor (TLD) XML file.

    This stores the raw result of parsing an TLD XML file, flattening different version of the descriptors to a common format. This is different to a TagLibraryInfo instance that would be passed to a tag validator in that it does not contain the uri and prefix values used by a JSP to reference this tag library.

    • Constructor Summary

      Constructors 
      Constructor Description
      TaglibXml()
      Constructs a new TaglibXml.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addFunction​(java.lang.String name, java.lang.String klass, java.lang.String signature)
      Adds a function definition to this tag library.
      void addListener​(java.lang.String listener)
      Adds a listener class name to this tag library.
      void addTag​(TagXml tag)
      Adds a tag definition to this tag library.
      void addTagFile​(TagFileXml tag)
      Adds a tag file definition to this tag library.
      java.util.List<FunctionInfo> getFunctions()
      Returns the list of function definitions.
      java.lang.String getInfo()
      Returns the description information.
      java.lang.String getJspVersion()
      Returns the JSP version requirement.
      java.util.List<java.lang.String> getListeners()
      Returns the list of listener class names.
      java.lang.String getShortName()
      Returns the short name of the tag library.
      java.util.List<TagFileXml> getTagFiles()
      Returns the list of tag file definitions.
      java.util.List<TagXml> getTags()
      Returns the list of tag definitions.
      java.lang.String getTlibVersion()
      Returns the tag library version.
      java.lang.String getUri()
      Returns the URI of the tag library.
      ValidatorXml getValidator()
      Returns the validator configuration.
      void setInfo​(java.lang.String info)
      Sets the description information.
      void setJspVersion​(java.lang.String jspVersion)
      Sets the JSP version requirement.
      void setShortName​(java.lang.String shortName)
      Sets the short name of the tag library.
      void setTlibVersion​(java.lang.String tlibVersion)
      Sets the tag library version.
      void setUri​(java.lang.String uri)
      Sets the URI of the tag library.
      void setValidator​(ValidatorXml validator)
      Sets the validator configuration.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • TaglibXml

        public TaglibXml()
        Constructs a new TaglibXml.

    • Method Detail

      • getTlibVersion

        public java.lang.String getTlibVersion()
        Returns the tag library version.
        Returns:
        the library version

      • setTlibVersion

        public void setTlibVersion​(java.lang.String tlibVersion)
        Sets the tag library version.
        Parameters:
        tlibVersion - the library version

      • getJspVersion

        public java.lang.String getJspVersion()
        Returns the JSP version requirement.
        Returns:
        the JSP version

      • setJspVersion

        public void setJspVersion​(java.lang.String jspVersion)
        Sets the JSP version requirement.
        Parameters:
        jspVersion - the JSP version

      • getShortName

        public java.lang.String getShortName()
        Returns the short name of the tag library.
        Returns:
        the short name

      • setShortName

        public void setShortName​(java.lang.String shortName)
        Sets the short name of the tag library.
        Parameters:
        shortName - the short name

      • getUri

        public java.lang.String getUri()
        Returns the URI of the tag library.
        Returns:
        the URI

      • setUri

        public void setUri​(java.lang.String uri)
        Sets the URI of the tag library.
        Parameters:
        uri - the URI

      • getInfo

        public java.lang.String getInfo()
        Returns the description information.
        Returns:
        the info

      • setInfo

        public void setInfo​(java.lang.String info)
        Sets the description information.
        Parameters:
        info - the info

      • getValidator

        public ValidatorXml getValidator()
        Returns the validator configuration.
        Returns:
        the validator

      • setValidator

        public void setValidator​(ValidatorXml validator)
        Sets the validator configuration.
        Parameters:
        validator - the validator

      • addTag

        public void addTag​(TagXml tag)
        Adds a tag definition to this tag library.
        Parameters:
        tag - the tag to add

      • getTags

        public java.util.List<TagXml> getTags()
        Returns the list of tag definitions.
        Returns:
        the tags

      • addTagFile

        public void addTagFile​(TagFileXml tag)
        Adds a tag file definition to this tag library.
        Parameters:
        tag - the tag file to add

      • getTagFiles

        public java.util.List<TagFileXml> getTagFiles()
        Returns the list of tag file definitions.
        Returns:
        the tag files

      • addListener

        public void addListener​(java.lang.String listener)
        Adds a listener class name to this tag library.
        Parameters:
        listener - the listener class name

      • getListeners

        public java.util.List<java.lang.String> getListeners()
        Returns the list of listener class names.
        Returns:
        the listeners

      • addFunction

        public void addFunction​(java.lang.String name,
                        java.lang.String klass,
                        java.lang.String signature)
        Adds a function definition to this tag library.
        Parameters:
        name - the function name
        klass - the function class
        signature - the function signature

      • getFunctions

        public java.util.List<FunctionInfo> getFunctions()
        Returns the list of function definitions.
        Returns:
        the functions