Package xyz.paradoxv5

Class MyString

java.lang.Object

xyz.paradoxv5.MyString

All Implemented Interfaces:

Serializable, CharSequence, Cloneable, Comparable<@NotNull CharSequence>

public class MyString
extends Object
implements CharSequence, Comparable<@NotNull CharSequence>, Cloneable, Serializable

A CharSequence implementation backed by a Character List

The backing list determines whether the instance is mutable (i.e. writeable).

Version:

1L.0.1

Author:

ParadoxV5. Boost Software License 1.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MyString(char @NotNull ... charArray)
MyString(@NotNull CharSequence charSeq)
MyString(@NotNull List<Character> chars)

Method Summary

Modifier and Type	Method	Description
char	charAt(int index)
@NotNull MyString	clone()
int	compareTo(@NotNull CharSequence other)
MyString	deepClone()
boolean	equals(@Nullable Object obj)
@NotNull List<Character>	getChars()
int	hashCode()
int	length()
void	setChars(@NotNull List<Character> chars)
MyString	subSequence(int start, int end)
char @NotNull []	toCharArray()
@NotNull String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence

chars, codePoints, isEmpty

Constructor Details

MyString

@Contract(mutates="this")
public MyString(@NotNull
 @NotNull List<Character> chars)

MyString

@Contract(mutates="this")
public MyString(@NotNull
 @NotNull CharSequence charSeq)

MyString

@Contract(mutates="this")
public MyString(char @NotNull ... charArray)

Method Details

getChars

@Contract(value="-> _",
          pure=true)
@NotNull
public @NotNull List<Character> getChars()

setChars

@Contract(mutates="this")
public void setChars(@NotNull
 @NotNull List<Character> chars)

charAt

@Contract(value="_ -> _",
          pure=true)
public char charAt(int index)

Specified by:

charAt in interface CharSequence

length

@Contract(value="-> _",
          pure=true)
public int length()

Specified by:

length in interface CharSequence

subSequence

@Contract(value="_, _ -> new",
          pure=true)
public MyString subSequence(int start,
 int end)

Specified by:

subSequence in interface CharSequence

compareTo

@Contract(value="_ -> _",
          pure=true)
public int compareTo(@NotNull
 @NotNull CharSequence other)

Specified by:

compareTo in interface Comparable<@NotNull CharSequence>

toCharArray

@Contract(value="-> new",
          pure=true)
public char @NotNull [] toCharArray()

toString

@Contract(value="-> _",
          pure=true)
@NotNull
public @NotNull String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

deepClone

@Contract(value="-> new",
          pure=true)
public MyString deepClone()

equals

@Contract(value="null -> false; !null -> _",
          pure=true)
public boolean equals(@Nullable
 @Nullable Object obj)

Overrides:

equals in class Object

hashCode

@Contract(value="-> _",
          pure=true)
public int hashCode()

Overrides:

hashCode in class Object

clone

@Contract(value="-> new",
          pure=true)
@NotNull
public @NotNull MyString clone()
                        throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException