Package nz.org.riskscape.config

Interface ConfigString

All Superinterfaces:

CharSequence

All Known Implementing Classes:

ConfigString.Wrapper

public interface ConfigString
extends CharSequence

A ConfigString is a wrapper around some other string that includes the location of this value, i.e. the file resource that defines it (like an ini file).

This class can be used with binding to transparently include the locations of problematic values, so that error messages can direct the user to the problem.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ConfigString.Wrapper	Utility base class.

Method Summary

Modifier and Type	Method	Description
static ConfigString	anon(CharSequence value)
URI	getLocation()
default boolean	isAnonymous()
String	toString()	The string being wrapped
static ConfigString	wrap(URI location, CharSequence value)

Methods inherited from interface java.lang.CharSequence

charAt, chars, codePoints, isEmpty, length, subSequence

Method Details

anon

static ConfigString anon(CharSequence value)

Returns:

a ConfigString that wraps the given value, but without a known location.

wrap

static ConfigString wrap(URI location,
 CharSequence value)

Returns:

a ConfigString that uses the given location and value

toString

String toString()

The string being wrapped

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

getLocation

URI getLocation()

Returns:

a location where this ConfigString was defined.

isAnonymous

default boolean isAnonymous()

Returns:

true if this ConfigStrings location is Resource.UNKNOWN_URI