Class TestTag

  • All Implemented Interfaces:
    java.io.Serializable

    @API(status=STABLE,
         since="1.0")
    public final class TestTag
    extends java.lang.Object
    implements java.io.Serializable
    Immutable value object for a tag that is assigned to a test or container.
    Since:
    1.0
    See Also:
    isValid(String), create(String), Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String name  
      static java.util.Set<java.lang.String> RESERVED_CHARACTERS
      Reserved characters that are not permissible as part of a tag name.
      private static long serialVersionUID  
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private TestTag​(java.lang.String name)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static TestTag create​(java.lang.String name)
      Create a TestTag from the supplied name.
      private static boolean doesNotContainReservedCharacter​(java.lang.String str)  
      boolean equals​(java.lang.Object obj)  
      java.lang.String getName()
      Get the name of this tag.
      int hashCode()  
      static boolean isValid​(java.lang.String name)
      Determine if the supplied tag name is valid with regard to the supported syntax for tags.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • name

        private final java.lang.String name
      • RESERVED_CHARACTERS

        public static final java.util.Set<java.lang.String> RESERVED_CHARACTERS
        Reserved characters that are not permissible as part of a tag name.
        • ,: comma
        • (: left parenthesis
        • ): right parenthesis
        • &: ampersand
        • |: vertical bar
        • !: exclamation point
    • Constructor Detail

      • TestTag

        private TestTag​(java.lang.String name)
    • Method Detail

      • doesNotContainReservedCharacter

        private static boolean doesNotContainReservedCharacter​(java.lang.String str)
      • create

        public static TestTag create​(java.lang.String name)
                              throws PreconditionViolationException
        Create a TestTag from the supplied name.

        Consider checking whether the syntax of the supplied name is valid before attempting to create a TestTag using this factory method.

        Note: the supplied name will be trimmed.

        Parameters:
        name - the name of the tag; must be syntactically valid
        Throws:
        PreconditionViolationException - if the supplied tag name is not syntactically valid
        See Also:
        isValid(String)
      • getName

        public java.lang.String getName()
        Get the name of this tag.
        Returns:
        the name of this tag; never null or blank
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

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