BooleanValueFactory (ModeShape Distribution Library Reference (5.0.0.Final))

java.lang.Object
- org.modeshape.jcr.value.basic.AbstractValueFactory<Boolean>
- - org.modeshape.jcr.value.basic.BooleanValueFactory

All Implemented Interfaces:

ValueFactory<Boolean>
```
@Immutable
public class BooleanValueFactory
extends AbstractValueFactory<Boolean>
```
The standard ValueFactory for PropertyType.BOOLEAN values.

Nested Class Summary
- Nested classes/interfaces inherited from class org.modeshape.jcr.value.basic.AbstractValueFactory
  AbstractValueFactory.ConvertingIterator<ValueType>

Field Summary
- Fields inherited from class org.modeshape.jcr.value.basic.AbstractValueFactory
  decoder, propertyType, valueFactories
- Fields inherited from interface org.modeshape.jcr.value.ValueFactory
  DEFAULT_DECODER, DEFAULT_ENCODER

Constructor Summary

Constructors
Constructor and Description

BooleanValueFactory(TextDecoder decoder, ValueFactories factories)
Create a new instance.

Constructors
Constructor and Description
`BooleanValueFactory(TextDecoder decoder, ValueFactories factories)` Create a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`create(BigDecimal value)` Create a value from a decimal.
`Boolean`	`create(BinaryValue value)` Create a value from the binary content given by the supplied stream.
`Boolean`	`create(boolean value)` Create a boolean from a string.
`Boolean`	`create(byte[] value)` Create a value from the binary content given by the supplied array.
`Boolean`	`create(Calendar value)` Create a value from a Calendar instance.
`Boolean`	`create(Date value)` Create a value from a date.
`Boolean`	`create(DateTime value)` Create a value from a date-time instant.
`Boolean`	`create(double value)` Create a value from a double.
`Boolean`	`create(float value)` Create a value from a float.
`Boolean`	`create(InputStream stream)` Create a value from the binary content given by the supplied stream.
`Boolean`	`create(int value)` Create a value from an integer.
`Boolean`	`create(long value)` Create a long from a string.
`Boolean`	`create(Name value)` Create a value from a name.
`Boolean`	`create(NodeKey value)` Create a value from a `NodeKey`.
`Boolean`	`create(Path.Segment value)` Create a value from a path segment.
`Boolean`	`create(Path value)` Create a value from a path.
`Boolean`	`create(Reference value)` Create a value from a reference.
`Boolean`	`create(String value)` Create a value from a string, using no decoding.
`Boolean`	`create(String value, TextDecoder decoder)` Create a value from a string, using the supplied decoder.
`Boolean`	`create(URI value)` Create a value from a URI.
`Boolean`	`create(UUID value)` Create a value from a UUID.
`Boolean[]`	`createEmptyArray(int length)` Creates an empty array of the given type.
`BooleanValueFactory`	`with(ValueFactories valueFactories)` Return a potentially new copy of this factory that uses the supplied ValueFactories object.

Methods inherited from class org.modeshape.jcr.value.basic.AbstractValueFactory
create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, getDecoder, getDecoder, getPropertyType, getStringValueFactory

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BooleanValueFactory
```
public BooleanValueFactory(TextDecoder decoder,
                           ValueFactories factories)
```
    Create a new instance.
    
    Parameters:
    
    decoder - the text decoder; may be null if the default decoder should be used
    
    factories - the set of value factories, used to obtain the string value factory; may not be null
- Method Detail
  - with
```
public BooleanValueFactory with(ValueFactories valueFactories)
```
    Description copied from interface: ValueFactory
    
    Return a potentially new copy of this factory that uses the supplied ValueFactories object.
    
    Parameters:
    
    valueFactories - the value factories object; may not be null
    
    Returns:
    
    the factory, which may be a new instance or may be this object if the supplied value factories is the same as used by this factory; never null
  - create
```
public Boolean create(String value)
```
    Description copied from interface: ValueFactory
    
    Create a value from a string, using no decoding.
    
    Parameters:
    
    value - the string from which the value is to be created
    
    Returns:
    
    the value, or null if the supplied string is null
    
    See Also:
    
    ValueFactory.create(String, TextDecoder)
  - create
```
public Boolean create(String value,
                      TextDecoder decoder)
```
    Description copied from interface: ValueFactory
    
    Create a value from a string, using the supplied decoder.
    
    Parameters:
    
    value - the string from which the value is to be created
    
    decoder - the decoder that should be used; if null, the default decoder is used
    
    Returns:
    
    the value, or null if the supplied string is null
    
    See Also:
    
    ValueFactory.create(String)
  - create
```
public Boolean create(int value)
```
    Description copied from interface: ValueFactory
    
    Create a value from an integer.
    
    Parameters:
    
    value - the integer from which the value is to be created
    
    Returns:
    
    the value; never null
  - create
```
public Boolean create(long value)
```
    Description copied from interface: ValueFactory
    
    Create a long from a string.
    
    Parameters:
    
    value - the string from which the long is to be created
    
    Returns:
    
    the value; never null
  - create
```
public Boolean create(boolean value)
```
    Description copied from interface: ValueFactory
    
    Create a boolean from a string.
    
    Parameters:
    
    value - the boolean from which the value is to be created
    
    Returns:
    
    the value; never null
  - create
```
public Boolean create(float value)
```
    Description copied from interface: ValueFactory
    
    Create a value from a float.
    
    Parameters:
    
    value - the float from which the value is to be created
    
    Returns:
    
    the value; never null
  - create
```
public Boolean create(double value)
```
    Description copied from interface: ValueFactory
    
    Create a value from a double.
    
    Parameters:
    
    value - the double from which the value is to be created
    
    Returns:
    
    the value; never null
  - create
```
public Boolean create(BigDecimal value)
```
    Description copied from interface: ValueFactory
    
    Create a value from a decimal.
    
    Parameters:
    
    value - the decimal from which the value is to be created
    
    Returns:
    
    the value, or null if the supplied decimal is null
  - create
```
public Boolean create(Calendar value)
```
    Description copied from interface: ValueFactory
    
    Create a value from a Calendar instance.
    
    Parameters:
    
    value - the Calendar instance from which the value is to be created
    
    Returns:
    
    the value, or null if the supplied Calendar is null
  - create
```
public Boolean create(Date value)
```
    Description copied from interface: ValueFactory
    
    Create a value from a date.
    
    Parameters:
    
    value - the date from which the value is to be created
    
    Returns:
    
    the value, or null if the supplied date is null
  - create
```
public Boolean create(DateTime value)
               throws ValueFormatException
```
    Description copied from interface: ValueFactory
    
    Create a value from a date-time instant.
    
    Parameters:
    
    value - the date-time instant from which the value is to be created
    
    Returns:
    
    the value, or null if the supplied date is null
    
    Throws:
    
    ValueFormatException - if the conversion from a Date could not be performed
  - create
```
public Boolean create(Name value)
```
    Description copied from interface: ValueFactory
    
    Create a value from a name.
    
    Parameters:
    
    value - the name from which the value is to be created
    
    Returns:
    
    the value, or null if the supplied name is null
  - create
```
public Boolean create(Path value)
```
    Description copied from interface: ValueFactory
    
    Create a value from a path.
    
    Parameters:
    
    value - the path from which the value is to be created
    
    Returns:
    
    the value, or null if the supplied path is null
  - create
```
public Boolean create(Path.Segment value)
```
    Description copied from interface: ValueFactory
    
    Create a value from a path segment.
    
    Parameters:
    
    value - the path segment from which the value is to be created
    
    Returns:
    
    the value, or null if the supplied path segment is null
  - create
```
public Boolean create(Reference value)
```
    Description copied from interface: ValueFactory
    
    Create a value from a reference.
    
    Parameters:
    
    value - the reference from which the value is to be created
    
    Returns:
    
    the value, or null if the supplied reference is null
  - create
```
public Boolean create(URI value)
```
    Description copied from interface: ValueFactory
    
    Create a value from a URI.
    
    Parameters:
    
    value - the URI from which the value is to be created
    
    Returns:
    
    the value, or null if the supplied URI is null
  - create
```
public Boolean create(UUID value)
```
    Description copied from interface: ValueFactory
    
    Create a value from a UUID.
    
    Parameters:
    
    value - the UUID from which the value is to be created
    
    Returns:
    
    the value, or null if the supplied URI is null
  - create
```
public Boolean create(NodeKey value)
               throws ValueFormatException
```
    Description copied from interface: ValueFactory
    
    Create a value from a NodeKey.
    
    Parameters:
    
    value - the node key from which the value is to be created
    
    Returns:
    
    the value, or null if the supplied URI is null
    
    Throws:
    
    ValueFormatException - if the conversion from a NodeKey could not be performed
  - create
```
public Boolean create(byte[] value)
```
    Description copied from interface: ValueFactory
    
    Create a value from the binary content given by the supplied array.
    
    Parameters:
    
    value - the content to be used to create the value
    
    Returns:
    
    the value, or null if the supplied stream is null
  - create
```
public Boolean create(BinaryValue value)
               throws ValueFormatException,
                      IoException
```
    Description copied from interface: ValueFactory
    
    Create a value from the binary content given by the supplied stream.
    
    Parameters:
    
    value - the binary object to be used to create the value
    
    Returns:
    
    the value, or null if the supplied stream is null
    
    Throws:
    
    ValueFormatException - if the conversion from the binary object could not be performed
    
    IoException - If an unexpected problem occurs while accessing the supplied binary value (such as an IOException).
  - create
```
public Boolean create(InputStream stream)
               throws IoException
```
    Description copied from interface: ValueFactory
    
    Create a value from the binary content given by the supplied stream.
    
    Parameters:
    
    stream - the stream containing the content to be used to create the value
    
    Returns:
    
    the value, or null if the supplied stream is null
    
    Throws:
    
    IoException - If an unexpected problem occurs while accessing the supplied stream (such as an IOException).
  - createEmptyArray
```
public Boolean[] createEmptyArray(int length)
```
    Description copied from interface: ValueFactory
    
    Creates an empty array of the given type.
    
    Parameters:
    
    length - the length of the array; must be a positive value
    
    Returns:
    
    an empty array of the given length.

Class BooleanValueFactory

Nested Class Summary

Nested classes/interfaces inherited from class org.modeshape.jcr.value.basic.AbstractValueFactory

Field Summary

Fields inherited from class org.modeshape.jcr.value.basic.AbstractValueFactory

Fields inherited from interface org.modeshape.jcr.value.ValueFactory

Constructor Summary

Method Summary

Methods inherited from class org.modeshape.jcr.value.basic.AbstractValueFactory

Methods inherited from class java.lang.Object

Constructor Detail

BooleanValueFactory

Method Detail

with

create

create

create

create

create

create

create

create

create

create

create

create

create

create

create

create

create

create

create

create

create

createEmptyArray