QVCPath

java.lang.Object

com.io7m.quarrel.core.converters.QVCAbstract<Path>

com.io7m.quarrel.core.converters.QVCPath

All Implemented Interfaces:: QValueConverterType<Path>

public final class QVCPath extends QVCAbstract<Path>

A value converter.

Method Summary

Modifier and Type

Method

Description

Class<Path>

convertedClass()

String

convertToString(Path value)

Convert a value of T to a string.

Path

exampleValue()

static QValueConverterType<Path>

get()

protected Path

parse(String text)

String

syntax()

Methods inherited from class com.io7m.quarrel.core.converters.QVCAbstract
convertFromString

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

Method Details
- get
  
  public static QValueConverterType<Path> get()
  
  Returns:
  
  A value converter.
- parse
  
  protected Path parse(String text) throws Exception
  
  Specified by:
  
  parse in class QVCAbstract<Path>
  
  Throws:
  
  Exception
- convertToString
  
  public String convertToString(Path value)
  
  Description copied from interface: QValueConverterType
  
  Convert a value of T to a string.
  
  Parameters:
  
  value - The value
  
  Returns:
  
  A string
- exampleValue
  
  public Path exampleValue()
  
  Returns:
  
  An example value used for documentation
- syntax
  
  public String syntax()
  
  Returns:
  
  A description of the syntax for valid values of T
- convertedClass
  
  public Class<Path> convertedClass()
  
  Returns:
  
  The type that will be converted