Class UniqueId

    • Method Detail

      • parse

        public static UniqueId parse​(String uniqueId)
                              throws JUnitException
        Parse a UniqueId from the supplied string representation using the default format.
        Parameters:
        uniqueId - the string representation to parse; never null or blank
        Returns:
        a properly constructed UniqueId
        Throws:
        JUnitException - if the string cannot be parsed
      • forEngine

        public static UniqueId forEngine​(String engineId)
        Create an engine's unique ID from its engineId using the default format.

        The engine ID will be stored in a UniqueId.Segment with type "engine".

        Parameters:
        engineId - the engine ID; never null or blank
        See Also:
        root(String, String)
      • root

        public static UniqueId root​(String segmentType,
                                    String value)
        Create a root unique ID from the supplied segmentType and value using the default format.
        Parameters:
        segmentType - the segment type; never null or blank
        value - the value; never null or blank
        See Also:
        forEngine(String)
      • append

        public final UniqueId append​(String segmentType,
                                     String value)
        Construct a new UniqueId by appending a new UniqueId.Segment, based on the supplied segmentType and value, to the end of this UniqueId.

        This UniqueId will not be modified.

        Neither the segmentType nor the value may contain any of the special characters used for constructing the string representation of this UniqueId.

        Parameters:
        segmentType - the type of the segment; never null or blank
        value - the value of the segment; never null or blank
      • hasPrefix

        @API(status=STABLE,
             since="1.1")
        public boolean hasPrefix​(UniqueId potentialPrefix)
        Determine if the supplied UniqueId is a prefix for this UniqueId.
        Parameters:
        potentialPrefix - the UniqueId to be checked; never null
        Since:
        1.1
      • hashCode

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

        public String toString()
        Generate the unique, formatted string representation of this UniqueId using the configured UniqueIdFormat.
        Overrides:
        toString in class Object