org.pfsw.bif.text

Interface IStringPair

All Known Subinterfaces:

IMutableStringPair

All Known Implementing Classes:

CollectionUtil.LocalStringPair, NamedText, StringPair

public interface IStringPair

Specifies a pair of String objects. Such pairs quite common and deserve to be modeled in a separate interface.

Field Summary

Fields

Modifier and Type	Field and Description
static IStringPair[]	EMPTY_ARRAY An immutable empty array of this type.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	asArray() Returns both strings of this pair in a String array.
java.lang.String	asString(java.lang.String separator) Returns the two strings as one string separated by the given separator.
java.lang.String	getString1() Returns the first string of this pair.
java.lang.String	getString2() Returns the second string of this pair.

Field Detail

EMPTY_ARRAY

static final IStringPair[] EMPTY_ARRAY

An immutable empty array of this type.

Method Detail

getString1

java.lang.String getString1()

Returns the first string of this pair.

getString2

java.lang.String getString2()

Returns the second string of this pair.

asArray

java.lang.String[] asArray()

Returns both strings of this pair in a String array.

asString

java.lang.String asString(java.lang.String separator)

Returns the two strings as one string separated by the given separator. If the provided separator is null, no separator should be put between the strings.

Parameters:

separator - A separator to be placed between the two strings.