Package net.sf.saxon.value
Class BooleanValue
java.lang.Object
net.sf.saxon.value.Value
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.BooleanValue
- All Implemented Interfaces:
Serializable
,Comparable
,PullEvent
,SequenceIterable
,GroundedValue
,Item
,ValueRepresentation
,ConversionResult
A boolean XPath value
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final BooleanValue
The boolean value FALSEstatic final BooleanValue
The boolean value TRUEFields inherited from class net.sf.saxon.value.AtomicValue
typeLabel
Fields inherited from class net.sf.saxon.value.Value
EMPTY_CLASS_ARRAY, INDETERMINATE_ORDERING
Fields inherited from interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY
-
Constructor Summary
ConstructorsConstructorDescriptionBooleanValue
(boolean value, AtomicType typeLabel) Create a new Boolean value with a user-supplied type label. -
Method Summary
Modifier and TypeMethodDescriptionint
Compare the value to another boolean valueconvertPrimitive
(BuiltInAtomicType requiredType, boolean validate, XPathContext context) Convert to target data typecopyAsSubType
(AtomicType typeLabel) Create a copy of this atomic value (usually so that the type label can be changed).boolean
Get the effective boolean value of this expressionboolean
Determine whether two boolean values are equalstatic ConversionResult
Convert a string to a boolean value, using the XML Schema rules (including whitespace trimming)static BooleanValue
get
(boolean value) Factory method: get a BooleanValueboolean
Get the valueDetermine the primitive type of the value.Get a Comparable value that implements the XML Schema ordering comparison semantics for this value.Convert to stringgetXPathComparable
(boolean ordered, StringCollator collator, XPathContext context) Get a Comparable value that implements the XPath ordering comparison semantics for this value.int
hashCode()
Get a hash code for comparing two BooleanValuestoString()
Diagnostic display of this value as a stringMethods inherited from class net.sf.saxon.value.AtomicValue
asAtomic, checkPermittedContents, convert, convert, getCardinality, getComponent, getItemType, getLength, getStringValueCS, getTypedValue, getTypeLabel, isNaN, itemAt, iterate, process, setTypeLabel, subsequence
Methods inherited from class net.sf.saxon.value.Value
asItem, asItem, asIterator, asValue, convertToJava, fromItem, getCanonicalLexicalRepresentation, getIterator, iterate, makeQNameValue, reduce, stringToNumber
-
Field Details
-
TRUE
The boolean value TRUE -
FALSE
The boolean value FALSE
-
-
Constructor Details
-
BooleanValue
Create a new Boolean value with a user-supplied type label. It is the caller's responsibility to ensure that the value is valid for the subtype- Parameters:
value
- the boolean valuetypeLabel
- the type label, xs:boolean or a subtype
-
-
Method Details
-
get
Factory method: get a BooleanValue- Parameters:
value
- true or false, to determine which boolean value is required- Returns:
- the BooleanValue requested
-
copyAsSubType
Create a copy of this atomic value (usually so that the type label can be changed). The type label of the copy will be reset to the primitive type.- Specified by:
copyAsSubType
in classAtomicValue
- Parameters:
typeLabel
- the atomic type label to be added to the copied value- Returns:
- the copied value
-
fromString
Convert a string to a boolean value, using the XML Schema rules (including whitespace trimming)- Parameters:
s
- the input string- Returns:
- the relevant BooleanValue if validation succeeds; or a ValidationFailure if not.
-
getBooleanValue
public boolean getBooleanValue()Get the value- Returns:
- true or false, the actual boolean value of this BooleanValue
-
effectiveBooleanValue
public boolean effectiveBooleanValue()Get the effective boolean value of this expression- Overrides:
effectiveBooleanValue
in classAtomicValue
- Returns:
- the boolean value
-
getPrimitiveType
Determine the primitive type of the value. This delivers the same answer as getItemType().getPrimitiveItemType(). The primitive types are the 19 primitive types of XML Schema, plus xs:integer, xs:dayTimeDuration and xs:yearMonthDuration, and xs:untypedAtomic. For external objects, the result is AnyAtomicType.- Specified by:
getPrimitiveType
in classAtomicValue
- Returns:
- the primitive type
-
convertPrimitive
public ConversionResult convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context) Convert to target data type- Specified by:
convertPrimitive
in classAtomicValue
- Parameters:
requiredType
- an integer identifying the required atomic typecontext
- XPath dynamic contextvalidate
- true if validation is required. If set to false, the caller guarantees that the value is valid for the target data type, and that further validation is therefore not required. Note that a validation failure may be reported even if validation was not requested.- Returns:
- an AtomicValue, a value of the required type
-
getStringValue
Convert to string- Specified by:
getStringValue
in interfaceItem
- Specified by:
getStringValue
in interfaceValueRepresentation
- Specified by:
getStringValue
in classAtomicValue
- Returns:
- "true" or "false"
- See Also:
-
getSchemaComparable
Get a Comparable value that implements the XML Schema ordering comparison semantics for this value. The default implementation returns "this". This is overridden for particular atomic types.In the case of data types that are partially ordered, the returned Comparable extends the standard semantics of the compareTo() method by returning the value
Value.INDETERMINATE_ORDERING
when there is no defined order relationship between two given values.- Specified by:
getSchemaComparable
in classAtomicValue
- Returns:
- a Comparable that follows XML Schema comparison rules
-
getXPathComparable
Get a Comparable value that implements the XPath ordering comparison semantics for this value. Returns null if the value is not comparable according to XPath rules. The default implementation returns null. This is overridden for types that allow ordered comparisons in XPath: numeric, boolean, string, date, time, dateTime, yearMonthDuration, dayTimeDuration, and anyURI.- Specified by:
getXPathComparable
in classAtomicValue
- Parameters:
ordered
-collator
-context
-- Returns:
- an Object whose equals() and hashCode() methods implement the XPath comparison semantics with respect to this atomic value. If ordered is specified, the result will either be null if no ordering is defined, or will be a Comparable
-
compareTo
Compare the value to another boolean value- Specified by:
compareTo
in interfaceComparable
- Parameters:
other
- The other boolean value- Returns:
- -1 if this one is the lower, 0 if they are equal, +1 if this one is the higher. False is considered to be less than true.
- Throws:
ClassCastException
- if the other value is not a BooleanValue (the parameter is declared as Object to satisfy the Comparable interface)
-
equals
Determine whether two boolean values are equal- Specified by:
equals
in classAtomicValue
- Parameters:
other
- the value to be compared to this value- Returns:
- true if the other value is a boolean value and is equal to this value
- Throws:
ClassCastException
- if other value is not xs:boolean or derived therefrom
-
hashCode
public int hashCode()Get a hash code for comparing two BooleanValues -
toString
Diagnostic display of this value as a string- Overrides:
toString
in classAtomicValue
- Returns:
- a string representation of this value: "true()" or "false()"
-