SingleString (Purity 0.14 API)

java.lang.Object
- com.willhains.purity.SingleString<This>

Type Parameters:

This - Self-reference to the subclass type itself.

All Implemented Interfaces:

SingleComparable<This>, CharSequence, Comparable<This>, Supplier<String>
```
public abstract class SingleString<This extends SingleString<This>>
extends Object
implements SingleComparable<This>, CharSequence, Supplier<String>
```
A value type wrapping a String.

Author:

willhains

Field Summary

Fields
Modifier and Type Field Description

protected String raw
The raw underlying value.

Fields
Modifier and Type	Field	Description
`protected String`	`raw`	The raw underlying value.

Constructor Summary

Constructors
Modifier Constructor Description

protected SingleString(String rawValue, Function<? super String,? extends This> constructor)

Constructors
Modifier	Constructor	Description
`protected`	`SingleString(String rawValue, Function<? super String,? extends This> constructor)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`char`	`charAt(int position)`
`char`	`charAt(IntSupplier position)`
`int`	`compareTo(This that)`
`boolean`	`equals(Object other)`
`boolean`	`equals(This that)`
`Optional<This>`	`filter(Predicate<? super String> condition)`	Test the raw value by `condition`.
`This`	`flatMap(Function<? super String,? extends This> mapper)`	Construct a new value of this type with the raw underlying value converted by `mapper`.
`String`	`get()`
`int`	`hashCode()`
`boolean`	`is(Predicate<? super String> condition)`	Test the raw value with `condition`.
`boolean`	`isEmpty()`
`boolean`	`isNot(Predicate<? super String> condition)`	Reverse of `is(Predicate)`.
`boolean`	`isNotEmpty()`
`This`	`left(int length)`
`This`	`left(IntSupplier length)`
`int`	`length()`
`This`	`map(Function<? super String,? extends String> mapper)`	Construct a new value of this type with the raw underlying value converted by `mapper`.
`String`	`raw()`
`This`	`replaceLiteral(String literal, String replacement)`
`This`	`replaceLiteral(Supplier<String> literal, Supplier<String> replacement)`
`This`	`replaceRegex(String regex, String replacement)`
`This`	`replaceRegex(Supplier<String> regex, Supplier<String> replacement)`
`This`	`right(int length)`
`This`	`right(IntSupplier length)`
`This`	`subSequence(int start, int end)`
`This`	`subSequence(IntSupplier start, IntSupplier end)`
`String`	`toString()`
`This`	`trim()`

Methods inherited from interface java.lang.CharSequence
chars, codePoints

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

Methods inherited from interface com.willhains.purity.SingleComparable
isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo, max, min

- Field Detail
  - raw
```
protected final String raw
```
    The raw underlying value. This property should be used only when passing the underlying value to external APIs. As much as possible, use the wrapped value type.
- Constructor Detail
  - SingleString
```
protected SingleString(String rawValue,
                       Function<? super String,? extends This> constructor)
```
    Parameters:
    
    rawValue - The raw, immutable value this object will represent.
    
    constructor - A method reference to the constructor of the implementing subclass.
- Method Detail
  - raw
```
public final String raw()
```
  - get
```
public String get()
```
    Specified by:
    
    get in interface Supplier<This extends SingleString<This>>
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface CharSequence
    
    Overrides:
    
    toString in class Object
  - compareTo
```
public int compareTo(This that)
```
    Specified by:
    
    compareTo in interface Comparable<This extends SingleString<This>>
  - length
```
public final int length()
```
    Specified by:
    
    length in interface CharSequence
  - charAt
```
public final char charAt(int position)
```
    Specified by:
    
    charAt in interface CharSequence
  - charAt
```
public final char charAt(IntSupplier position)
```
  - subSequence
```
public final This subSequence(int start,
                              int end)
```
    Specified by:
    
    subSequence in interface CharSequence
    
    Returns:
    
    a new value of the same type from a substring.
  - subSequence
```
public final This subSequence(IntSupplier start,
                              IntSupplier end)
```
  - left
```
public final This left(int length)
```
    Returns:
    
    a new value of the same type, wrapping only the first (up to) length characters.
  - left
```
public final This left(IntSupplier length)
```
  - right
```
public final This right(int length)
```
    Returns:
    
    a new value of the same type, wrapping only the last (up to) length characters.
  - right
```
public final This right(IntSupplier length)
```
  - trim
```
public final This trim()
```
    Returns:
    
    a new value of the same type from the trimmed string.
  - isEmpty
```
public final boolean isEmpty()
```
    Returns:
    
    true if the raw string is zero-length; false otherwise.
  - isNotEmpty
```
public final boolean isNotEmpty()
```
    Returns:
    
    true if the raw string is non-zero-length; false otherwise.
  - replaceRegex
```
public final This replaceRegex(String regex,
                               String replacement)
```
    Returns:
    
    a new value of the same type with all instances of the specified pattern replaced.
  - replaceRegex
```
public final This replaceRegex(Supplier<String> regex,
                               Supplier<String> replacement)
```
  - replaceLiteral
```
public final This replaceLiteral(String literal,
                                 String replacement)
```
    Returns:
    
    a new value of the same type with all instances of the specified literal string replaced.
  - replaceLiteral
```
public final This replaceLiteral(Supplier<String> literal,
                                 Supplier<String> replacement)
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - equals
```
public final boolean equals(This that)
```
  - is
```
public final boolean is(Predicate<? super String> condition)
```
    Test the raw value with condition. This method is useful when using Optional.filter(java.util.function.Predicate<? super T>) or Stream.filter(java.util.function.Predicate<? super T>).
```
 optional.filter(x -> x.is(String::isEmpty))
 
```
    Parameters:
    
    condition - a Predicate that tests the raw value type.
    
    Returns:
    
    true if the underlying raw value satisfies condition; false otherwise.
  - isNot
```
public final boolean isNot(Predicate<? super String> condition)
```
    Reverse of is(Predicate).
  - filter
```
public final Optional<This> filter(Predicate<? super String> condition)
```
    Test the raw value by condition.
    
    Returns:
    
    an Optional containing this instance if the condition is met; empty otherwise.
    
    See Also:
    
    is(Predicate)
  - map
```
public final This map(Function<? super String,? extends String> mapper)
```
    Construct a new value of this type with the raw underlying value converted by mapper.
    
    Parameters:
    
    mapper - The mapping function to apply to the raw underlying value.
    
    Returns:
    
    A new instance of this type.
  - flatMap
```
public final This flatMap(Function<? super String,? extends This> mapper)
```
    Construct a new value of this type with the raw underlying value converted by mapper.
    
    Parameters:
    
    mapper - The mapping function to apply to the raw underlying value.
    
    Returns:
    
    The value returned by mapper.

Class SingleString<This extends SingleString<This>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from interface java.lang.CharSequence

Methods inherited from class java.lang.Object

Methods inherited from interface com.willhains.purity.SingleComparable

Field Detail

raw

Constructor Detail

SingleString

Method Detail

raw

get

toString

compareTo

length

charAt

charAt

subSequence

subSequence

left

left

right

right

trim

isEmpty

isNotEmpty

replaceRegex

replaceRegex

replaceLiteral

replaceLiteral

hashCode

equals

equals

is

isNot

filter

map

flatMap