PathCounterTemplate (Sosy-Lab Common Library)

java.lang.Object

org.sosy_lab.common.io.PathCounterTemplate

public final class PathCounterTemplate extends Object

A template for Path objects that uses a counter to produce paths with a fresh new name for every request.

Method Summary

Modifier and Type

Method

Description

Path

getFreshPath()

Construct a concrete Path that was not handed out by this instance before.

String

getTemplate()

Returns the raw template of this instance.

static PathCounterTemplate

ofFormatString(String pTemplate)

Create a new instance.

String

toString()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details
- ofFormatString
  
  public static PathCounterTemplate ofFormatString(String pTemplate)
  
  Create a new instance.
  
  Parameters:
  
  pTemplate - A non-null non-empty template String in the format for String.format(String, Object...) that is suited for exactly one argument of type int.
  
  Throws:
  
  IllegalFormatException - If the template is invalid.
- getFreshPath
  
  public Path getFreshPath()
  
  Construct a concrete Path that was not handed out by this instance before.
  
  Throws:
  
  IllegalFormatException - If the template is invalid, or the arguments does not match the template.
- getTemplate
  
  public String getTemplate()
  
  Returns the raw template of this instance.
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object