BooleanValue

java.lang.Object
- net.sf.saxon.value.Value
- - net.sf.saxon.value.AtomicValue
  - - net.sf.saxon.value.BooleanValue

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable, PullEvent, SequenceIterable, GroundedValue, Item, ValueRepresentation, ConversionResult
```
public final class BooleanValue
extends AtomicValue
implements java.lang.Comparable
```
A boolean XPath value

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static BooleanValue FALSE
The boolean value FALSE

static BooleanValue TRUE
The boolean value TRUE
- Fields 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

Fields
Modifier and Type	Field	Description
`static BooleanValue`	`FALSE`	The boolean value FALSE
`static BooleanValue`	`TRUE`	The boolean value TRUE

Constructor Summary

Constructors
Constructor Description

BooleanValue(boolean value, AtomicType typeLabel)
Create a new Boolean value with a user-supplied type label.

Constructors
Constructor	Description
`BooleanValue(boolean value, AtomicType typeLabel)`	Create a new Boolean value with a user-supplied type label.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(java.lang.Object other)`	Compare the value to another boolean value
`ConversionResult`	`convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)`	Convert to target data type
`AtomicValue`	`copyAsSubType(AtomicType typeLabel)`	Create a copy of this atomic value (usually so that the type label can be changed).
`boolean`	`effectiveBooleanValue()`	Get the effective boolean value of this expression
`boolean`	`equals(java.lang.Object other)`	Determine whether two boolean values are equal
`static ConversionResult`	`fromString(java.lang.CharSequence s)`	Convert a string to a boolean value, using the XML Schema rules (including whitespace trimming)
`static BooleanValue`	`get(boolean value)`	Factory method: get a BooleanValue
`boolean`	`getBooleanValue()`	Get the value
`BuiltInAtomicType`	`getPrimitiveType()`	Determine the primitive type of the value.
`java.lang.Comparable`	`getSchemaComparable()`	Get a Comparable value that implements the XML Schema ordering comparison semantics for this value.
`java.lang.String`	`getStringValue()`	Convert to string
`java.lang.Object`	`getXPathComparable(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 BooleanValues
`java.lang.String`	`toString()`	Diagnostic display of this value as a string

Methods 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 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class net.sf.saxon.value.Value
asItem, asItem, asIterator, asValue, convertToJava, fromItem, getCanonicalLexicalRepresentation, getIterator, iterate, makeQNameValue, reduce, stringToNumber

- Field Detail
  - TRUE
```
public static final BooleanValue TRUE
```
    The boolean value TRUE
  - FALSE
```
public static final BooleanValue FALSE
```
    The boolean value FALSE
- Constructor Detail
  - BooleanValue
```
public BooleanValue(boolean value,
                    AtomicType typeLabel)
```
    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 value
    
    typeLabel - the type label, xs:boolean or a subtype
- Method Detail
  - get
```
public static BooleanValue get(boolean value)
```
    Factory method: get a BooleanValue
    
    Parameters:
    
    value - true or false, to determine which boolean value is required
    
    Returns:
    
    the BooleanValue requested
  - copyAsSubType
```
public AtomicValue copyAsSubType(AtomicType typeLabel)
```
    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 class AtomicValue
    
    Parameters:
    
    typeLabel - the atomic type label to be added to the copied value
    
    Returns:
    
    the copied value
  - fromString
```
public static ConversionResult fromString(java.lang.CharSequence s)
```
    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 class AtomicValue
    
    Returns:
    
    the boolean value
  - getPrimitiveType
```
public BuiltInAtomicType 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 class AtomicValue
    
    Returns:
    
    the primitive type
  - convertPrimitive
```
public ConversionResult convertPrimitive(BuiltInAtomicType requiredType,
                                         boolean validate,
                                         XPathContext context)
```
    Convert to target data type
    
    Specified by:
    
    convertPrimitive in class AtomicValue
    
    Parameters:
    
    requiredType - an integer identifying the required atomic type
    
    context - XPath dynamic context
    
    validate - 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
```
public java.lang.String getStringValue()
```
    Convert to string
    
    Specified by:
    
    getStringValue in interface Item
    
    Specified by:
    
    getStringValue in interface ValueRepresentation
    
    Specified by:
    
    getStringValue in class AtomicValue
    
    Returns:
    
    "true" or "false"
    
    See Also:
    
    Item.getStringValueCS()
  - getSchemaComparable
```
public java.lang.Comparable 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 class AtomicValue
    
    Returns:
    
    a Comparable that follows XML Schema comparison rules
  - getXPathComparable
```
public java.lang.Object getXPathComparable(boolean ordered,
                                           StringCollator collator,
                                           XPathContext context)
```
    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 class AtomicValue
    
    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
```
public int compareTo(java.lang.Object other)
```
    Compare the value to another boolean value
    
    Specified by:
    
    compareTo in interface java.lang.Comparable
    
    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:
    
    java.lang.ClassCastException - if the other value is not a BooleanValue (the parameter is declared as Object to satisfy the Comparable interface)
  - equals
```
public boolean equals(java.lang.Object other)
```
    Determine whether two boolean values are equal
    
    Specified by:
    
    equals in class AtomicValue
    
    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:
    
    java.lang.ClassCastException - if other value is not xs:boolean or derived therefrom
  - hashCode
```
public int hashCode()
```
    Get a hash code for comparing two BooleanValues
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    the hash code
  - toString
```
public java.lang.String toString()
```
    Diagnostic display of this value as a string
    
    Overrides:
    
    toString in class AtomicValue
    
    Returns:
    
    a string representation of this value: "true()" or "false()"

Class BooleanValue

Field Summary

Fields inherited from class net.sf.saxon.value.AtomicValue

Fields inherited from class net.sf.saxon.value.Value

Fields inherited from interface net.sf.saxon.om.ValueRepresentation

Constructor Summary

Method Summary

Methods inherited from class net.sf.saxon.value.AtomicValue

Methods inherited from class java.lang.Object

Methods inherited from class net.sf.saxon.value.Value

Field Detail

TRUE

FALSE

Constructor Detail

BooleanValue

Method Detail

get

copyAsSubType

fromString

getBooleanValue

effectiveBooleanValue

getPrimitiveType

convertPrimitive

getStringValue

getSchemaComparable

getXPathComparable

compareTo

equals

hashCode

toString