Class VelocityFormatter.VelocityAlternator

  • Direct Known Subclasses:
    VelocityFormatter.VelocityAutoAlternator
    Enclosing class:
    VelocityFormatter

    public class VelocityFormatter.VelocityAlternator
    extends java.lang.Object
    Class that returns alternating values in a template. It stores a list of alternate Strings, whenever alternate() is called it switches to the next in the list. The current alternate is retrieved through toString() - i.e. just by referencing the object in a Velocity template. For an example of usage see the makeAlternator() method below.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String[] alternates  
      protected int current  
    • Constructor Summary

      Constructors 
      Constructor Description
      VelocityAlternator​(java.lang.String[] alternates)
      Constructor takes an array of Strings.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String alternate()
      Alternates to the next in the list.
      java.lang.String toString()
      Returns the current alternate.
      • Methods inherited from class java.lang.Object

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

      • alternates

        protected java.lang.String[] alternates
      • current

        protected int current
    • Constructor Detail

      • VelocityAlternator

        public VelocityAlternator​(java.lang.String[] alternates)
        Constructor takes an array of Strings.
        Parameters:
        alternates - A String[].
    • Method Detail

      • alternate

        public java.lang.String alternate()
        Alternates to the next in the list.
        Returns:
        The current alternate in the sequence.
      • toString

        public java.lang.String toString()
        Returns the current alternate.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A String.