org.lsst.gruth.jutils

Class NumberedStringGenerator

java.lang.Object

org.lsst.gruth.jutils.NumberedStringGenerator

public class NumberedStringGenerator
extends Object

This class helps creating Strings with incremental number value in it (such as incremental fileNames).

Instances must be created with a simplified pattern where the character '#' is the place holder for a number (integer).

Then other Strings containing the same pattern can be submitted with method submit and in the end the getNewString() method will yield the next numbered String.

So for example :

      String pattern = "aName#.something";
  NumberedStringGenerator generator = new NumberedStringGenerator(pattern) ;
  System.out.println(" first :" + generator.getNewString());
  // will yield : "aName0.something"
  generator.submit("aName0.something") ;
  generator.submit("aName11.something") ;
  generator.submit("aName1.something") ;
  System.out.println(" max :" + generator.getNewString());
  // will yield : "aName12.something"
 

Author:

bamade

Constructor Summary

Constructors

Constructor and Description
NumberedStringGenerator(String simplePattern) creates a generator that will compare Strings and will yield the next incremented String.

Method Summary

Modifier and Type	Method and Description
String	formatWith(int number)
int	getMax()
String	getMaxString()
String	getMinString()
String	getNewString()
boolean	submit(String candidate)

Methods inherited from class java.lang.Object

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

Constructor Detail

NumberedStringGenerator

public NumberedStringGenerator(String simplePattern)

creates a generator that will compare Strings and will yield the next incremented String.

Parameters:

simplePattern - a String with a '#' character as number placeholder

Throws:

IllegalArgumentException - if no '#' character in argument

Method Detail

submit

public boolean submit(String candidate)

Parameters:

candidate - any String that possibly matches the initial pattern

Returns:

true if matched false otherwise

getNewString

public String getNewString()

Returns:

a new String that has the highest number immediately after the highest matched String

getMaxString

public String getMaxString()

Returns:

the highest ranking submitted name

getMax

public int getMax()

Returns:

the max number found in submitted Strings; -1 if no string matched

getMinString

public String getMinString()

Returns:

the smallest numbered String being submitted or null if none matched

formatWith

public String formatWith(int number)

Parameters:

number -

Returns:

a formatted String using the parameter