Class IdentifierSequences


  • public final class IdentifierSequences
    extends java.lang.Object

    Objects of this class are kept at ITemplateContext in order to provide templates with a way to create unique id attribute values during template processing.

    Since:
    3.0.0
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.Map<java.lang.String,​java.lang.Integer> idCounts  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Integer getAndIncrementIDSeq​(java.lang.String id)
      Returns a new index (ID count) for a specific value of the id attribute, and increments the count.
      java.lang.Integer getNextIDSeq​(java.lang.String id)
      Returns the index (ID count) for a specific value of the id attribute without incrementing the count.
      java.lang.Integer getPreviousIDSeq​(java.lang.String id)
      Returns the last index (ID count) returned for a specific value of the id attribute (without incrementing the count).
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • idCounts

        private final java.util.Map<java.lang.String,​java.lang.Integer> idCounts
    • Constructor Detail

      • IdentifierSequences

        public IdentifierSequences()
    • Method Detail

      • getAndIncrementIDSeq

        public java.lang.Integer getAndIncrementIDSeq​(java.lang.String id)

        Returns a new index (ID count) for a specific value of the id attribute, and increments the count.

        Parameters:
        id - the ID for which the count will be computed
        Returns:
        the new count, ready to be used
      • getNextIDSeq

        public java.lang.Integer getNextIDSeq​(java.lang.String id)

        Returns the index (ID count) for a specific value of the id attribute without incrementing the count.

        Parameters:
        id - the ID for which the count will be retrieved
        Returns:
        the current count
      • getPreviousIDSeq

        public java.lang.Integer getPreviousIDSeq​(java.lang.String id)

        Returns the last index (ID count) returned for a specific value of the id attribute (without incrementing the count).

        Parameters:
        id - the ID for which the last count will be retrieved
        Returns:
        the count