PathTemplate (Sosy-Lab Common Library)

java.lang.Object

org.sosy_lab.common.io.PathTemplate

@Immutable public final class PathTemplate extends Object

A template for paths, from which a real path can be constructed by passing some values to fill in the blanks.

Method Summary

Modifier and Type

Method

Description

Path

getPath(Object... args)

Construct a concrete Path from this template and the given values.

String

getTemplate()

Returns the raw template of this instance.

static PathTemplate

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 PathTemplate ofFormatString(String pTemplate)
  
  Create a new instance.
  
  Parameters:
  
  pTemplate - A non-null non-empty template String in the format for String.format(String, Object...).
- getPath
  
  public Path getPath(Object... args)
  
  Construct a concrete Path from this template and the given values.
  
  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