Package com.ibm.fhir.path

Class FHIRPathStringValue

java.lang.Object

com.ibm.fhir.path.FHIRPathAbstractNode

com.ibm.fhir.path.FHIRPathStringValue

All Implemented Interfaces:

FHIRPathNode, FHIRPathSystemValue, Comparable<FHIRPathNode>

public class FHIRPathStringValue
extends FHIRPathAbstractNode
implements FHIRPathSystemValue

A FHIRPathSystemValue node that wraps a String value

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FHIRPathStringValue.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static FHIRPathStringValue	EMPTY_STRING

Fields inherited from class com.ibm.fhir.path.FHIRPathAbstractNode

children, name, path, type, value

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FHIRPathStringValue(FHIRPathStringValue.Builder builder)

Method Summary

Modifier and Type	Method	Description
void	accept(FHIRPathNodeVisitor visitor)	A method for accepting a FHIRPathNodeVisitor
static FHIRPathStringValue.Builder	builder(String string)	Static factory method for creating builder instances from a String value
int	compareTo(FHIRPathNode other)	Compare the String value wrapped by this FHIRPathStringValue node to the parameter
FHIRPathStringValue	concat(FHIRPathStringValue value)	Concatenate the String value with the String value wrapped by another FHIRPathStringValue
boolean	contains(FHIRPathStringValue substring)	Indicates whether this FHIRPathStringValue contains the substring in the parameter
boolean	endsWith(FHIRPathStringValue suffix)	Indicates whether this FHIRPathStringValue ends with the suffix in the parameter
boolean	equals(Object obj)	Indicates whether the String value wrapped by this FHIRPathStringValue node is equal the parameter (or its primitive value)
int	hashCode()
boolean	isComparableTo(FHIRPathNode other)	Indicates whether this FHIRPathStringValue is comparable to the parameter
boolean	isStringValue()	Indicates whether this FHIRPathSystemValue is type compatible with FHIRPathStringValue
int	length()	The length of this FHIRPathStringValue
FHIRPathStringValue	lower()	Convert the characters in this FHIRPathStringValue to lower case
boolean	matches(FHIRPathStringValue regex)	Indicates whether the String value wrapped by this FHIRPathStringValue matches the regex in the parameter
FHIRPathStringValue	replace(FHIRPathStringValue pattern, FHIRPathStringValue substitution)	Replace occurrences of pattern in this FHIRPathStringValue with substitution
FHIRPathStringValue	replaceMatches(FHIRPathStringValue regex, FHIRPathStringValue substitution)	Replace matches of regex in this FHIRPathStringValue with substitution
boolean	startsWith(FHIRPathStringValue prefix)	Indicates whether this FHIRPathStringValue starts with the prefix in the parameter
String	string()	The String value wrapped by this FHIRPathStringValue
static FHIRPathStringValue	stringValue(String string)	Static factory method for creating FHIRPathStringValue instances from a String value
static FHIRPathStringValue	stringValue(String name, String string)	Static factory method for creating named FHIRPathStringValue instances from a String value
FHIRPathStringValue	substring(int start)	Returns the part of this FHIRPathStringValue starting at position start
FHIRPathStringValue	substring(int start, int length)	Returns the part of this FHIRPathStringValue starting at position start up to length number of characters
FHIRPathStringValue.Builder	toBuilder()	Convert this FHIRPathNode instance into a FHIRPathNode.Builder instance
String	toString()
FHIRPathStringValue	upper()	Convert the characters in this FHIRPathStringValue to upper case

Methods inherited from class com.ibm.fhir.path.FHIRPathAbstractNode

as, children, descendants, getValue, hasValue, is, name, path, stream, type

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.fhir.path.FHIRPathNode

as, asElementNode, asResourceNode, asSystemValue, asTermServiceNode, asTypeInfoNode, children, descendants, getValue, is, isElementNode, isResourceNode, isTermServiceNode, isTypeInfoNode, name, path, stream, type

Methods inherited from interface com.ibm.fhir.path.FHIRPathSystemValue

asBooleanValue, asNumberValue, asQuantityValue, asStringValue, asTemporalValue, hasValue, isBooleanValue, isNumberValue, isQuantityValue, isSystemValue, isTemporalValue

Field Detail

EMPTY_STRING

public static final FHIRPathStringValue EMPTY_STRING

Constructor Detail

FHIRPathStringValue

protected FHIRPathStringValue(FHIRPathStringValue.Builder builder)

Method Detail

isStringValue

public boolean isStringValue()

Description copied from interface: FHIRPathSystemValue

Indicates whether this FHIRPathSystemValue is type compatible with FHIRPathStringValue

Specified by:

isStringValue in interface FHIRPathSystemValue

Returns:

true if this FHIRPathSystemValue is type compatible with FHIRPathStringValue, otherwise false

string

public String string()

The String value wrapped by this FHIRPathStringValue

Returns:

the String value wrapped by this FHIRPathStringValue

stringValue

public static FHIRPathStringValue stringValue(String string)

Static factory method for creating FHIRPathStringValue instances from a String value

Parameters:

string - the String value

Returns:

a new FHIRPathStringValue instance

stringValue

public static FHIRPathStringValue stringValue(String name,
                                              String string)

Static factory method for creating named FHIRPathStringValue instances from a String value

Parameters:

name - the name

string - the String value

Returns:

a new named FHIRPathStringValue instance

toBuilder

public FHIRPathStringValue.Builder toBuilder()

Description copied from class: FHIRPathAbstractNode

Convert this FHIRPathNode instance into a FHIRPathNode.Builder instance

Specified by:

toBuilder in class FHIRPathAbstractNode

Returns:

a new FHIRPathNode.Builder instance containing the fields from this FHIRPathNode instance

builder

public static FHIRPathStringValue.Builder builder(String string)

Static factory method for creating builder instances from a String value

Parameters:

string - the String value

Returns:

a new builder for building FHIRPathStringValue instances

concat

public FHIRPathStringValue concat(FHIRPathStringValue value)

Concatenate the String value with the String value wrapped by another FHIRPathStringValue

Parameters:

value - the other FHIRPathStringValue

Returns:

the result of concatenation between this FHIRPathStringValue and the parameter

startsWith

public boolean startsWith(FHIRPathStringValue prefix)

Indicates whether this FHIRPathStringValue starts with the prefix in the parameter

Parameters:

prefix - the prefix

Returns:

true if this FHIRPathStringValue starts with the parameter, otherwise false

endsWith

public boolean endsWith(FHIRPathStringValue suffix)

Indicates whether this FHIRPathStringValue ends with the suffix in the parameter

Parameters:

suffix - the suffix

Returns:

true if this FHIRPathStringValue ends with the parameter, otherwise false

replace

public FHIRPathStringValue replace(FHIRPathStringValue pattern,
                                   FHIRPathStringValue substitution)

Replace occurrences of pattern in this FHIRPathStringValue with substitution

Parameters:

pattern - the pattern

substitution - the substitution

Returns:

the result of replacing occurrences of pattern found in this FHIRPathStringValue with substitution

matches

public boolean matches(FHIRPathStringValue regex)

Indicates whether the String value wrapped by this FHIRPathStringValue matches the regex in the parameter

Parameters:

regex - the regex

Returns:

true if the String value wrapped by this FHIRPathStringValue matches the regex in the parameter

replaceMatches

public FHIRPathStringValue replaceMatches(FHIRPathStringValue regex,
                                          FHIRPathStringValue substitution)

Replace matches of regex in this FHIRPathStringValue with substitution

Parameters:

regex - the regex

substitution - the substitution

Returns:

the result of replacing matches of regex in this FHIRPathStringValue with substitution

substring

public FHIRPathStringValue substring(int start)

Returns the part of this FHIRPathStringValue starting at position start

Parameters:

start - the start

Returns:

the part of this FHIRPathStringValue starting at position start

substring

public FHIRPathStringValue substring(int start,
                                     int length)

Returns the part of this FHIRPathStringValue starting at position start up to length number of characters

Parameters:

start - the start

length - the length

Returns:

the part of this FHIRPathStringValue starting at position start up to length number of characters

contains

public boolean contains(FHIRPathStringValue substring)

Indicates whether this FHIRPathStringValue contains the substring in the parameter

Parameters:

substring - the substring

Returns:

true if this FHIRPathStringValue contains the substring in the parameter, otherwise false

length

public int length()

The length of this FHIRPathStringValue

Returns:

the length of this FHIRPathStringValue

lower

public FHIRPathStringValue lower()

Convert the characters in this FHIRPathStringValue to lower case

Returns:

the result of converting the characters in this FHIRPathString to lower case

upper

public FHIRPathStringValue upper()

Convert the characters in this FHIRPathStringValue to upper case

Returns:

the result of converting the characters in this FHIRPathString to upper case

isComparableTo

public boolean isComparableTo(FHIRPathNode other)

Indicates whether this FHIRPathStringValue is comparable to the parameter

Specified by:

isComparableTo in interface FHIRPathNode

Parameters:

other - the other FHIRPathNode

Returns:

true if the parameter or its primitive value is a FHIRPathStringValue, otherwise false

compareTo

public int compareTo(FHIRPathNode other)

Compare the String value wrapped by this FHIRPathStringValue node to the parameter

Specified by:

compareTo in interface Comparable<FHIRPathNode>

Parameters:

other - the other FHIRPathNode

Returns:

0 if the String value wrapped by this FHIRPathStringValue node is equal to the parameter; a positive value if this FHIRPathStringValue if the first non-matching character is greater than the character at the same index in the parameter; a positive value if this FHIRPathStringValue if the first non-matching character is less than the character at the same index in the parameter

equals

public boolean equals(Object obj)

Indicates whether the String value wrapped by this FHIRPathStringValue node is equal the parameter (or its primitive value)

Overrides:

equals in class Object

Parameters:

obj - the other Object

Returns:

true if the String value wrapped by this FHIRPathStringValue node is equal the parameter (or its primitive value), otherwise false

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

accept

public void accept(FHIRPathNodeVisitor visitor)

Description copied from interface: FHIRPathNode

A method for accepting a FHIRPathNodeVisitor

Specified by:

accept in interface FHIRPathNode

Parameters:

visitor - the FHIRPathNodeVisitor that this FHIRPathNode is accepting