Class CharsRef

Represents char[], as a slice (offset + Length) into an existing char[]. The Chars property should never be null; use EMPTY_CHARS if necessary.

This is a Lucene.NET INTERNAL API, use at your own risk

Inheritance

System.Object

CharsRef

Implements

System.IComparable<CharsRef>

J2N.Text.ICharSequence

System.IEquatable<CharsRef>

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Lucene.Net.Util

Assembly: Lucene.Net.dll

Syntax

[Serializable]
public sealed class CharsRef : IComparable<CharsRef>, ICharSequence, IEquatable<CharsRef>

Constructors

CharsRef()

Creates a new CharsRef initialized an empty array zero-Length

Declaration

public CharsRef()

CharsRef(Char[], Int32, Int32)

Creates a new CharsRef initialized with the given chars, offset and length.

Declaration

public CharsRef(char[] chars, int offset, int length)

Parameters

Type	Name	Description
System.Char[]	chars
System.Int32	offset
System.Int32	length

CharsRef(Int32)

Creates a new CharsRef initialized with an array of the given capacity.

Declaration

public CharsRef(int capacity)

Parameters

Type	Name	Description
System.Int32	capacity

CharsRef(String)

Creates a new CharsRef initialized with the given System.String character array.

Declaration

public CharsRef(string string)

Parameters

Type	Name	Description
System.String	string

Fields

EMPTY_CHARS

An empty character array for convenience

Declaration

public static readonly char[] EMPTY_CHARS

Field Value

Type	Description
System.Char[]

Properties

Chars

The contents of the CharsRef. Should never be null.

Declaration

public char[] Chars { get; set; }

Property Value

Type	Description
System.Char[]

Item[Int32]

Declaration

public char this[int index] { get; }

Parameters

Type	Name	Description
System.Int32	index

Property Value

Type	Description
System.Char

Length

Length of used characters.

Declaration

public int Length { get; set; }

Property Value

Type	Description
System.Int32

Offset

Offset of first valid character.

Declaration

public int Offset { get; }

Property Value

Type	Description
System.Int32

UTF16SortedAsUTF8Comparer

Declaration

[Obsolete("this comparer is only a transition mechanism")]
public static IComparer<CharsRef> UTF16SortedAsUTF8Comparer { get; }

Property Value

Type	Description
System.Collections.Generic.IComparer<CharsRef>

Methods

Append(Char[], Int32, Int32)

Appends the given array to this CharsRef.

Declaration

public void Append(char[] otherChars, int otherOffset, int otherLength)

Parameters

Type	Name	Description
System.Char[]	otherChars
System.Int32	otherOffset
System.Int32	otherLength

CharsEquals(CharsRef)

Declaration

public bool CharsEquals(CharsRef other)

Parameters

Type	Name	Description
CharsRef	other

Returns

Type	Description
System.Boolean

Clone()

Returns a shallow clone of this instance (the underlying characters are not copied and will be shared by both the returned object and this object.

Declaration

public object Clone()

Returns

Type	Description
System.Object

See Also

DeepCopyOf(CharsRef)

CompareTo(CharsRef)

Signed System.Int32 order comparison

Declaration

public int CompareTo(CharsRef other)

Parameters

Type	Name	Description
CharsRef	other

Returns

Type	Description
System.Int32

CopyChars(CharsRef)

Copies the given CharsRef referenced content into this instance.

Declaration

public void CopyChars(CharsRef other)

Parameters

Type	Name	Description
CharsRef	other	The CharsRef to copy.

CopyChars(Char[], Int32, Int32)

Copies the given array into this CharsRef.

Declaration

public void CopyChars(char[] otherChars, int otherOffset, int otherLength)

Parameters

Type	Name	Description
System.Char[]	otherChars
System.Int32	otherOffset
System.Int32	otherLength

DeepCopyOf(CharsRef)

Creates a new CharsRef that points to a copy of the chars from other.

The returned CharsRef will have a Length of other.Length and an offset of zero.

Declaration

public static CharsRef DeepCopyOf(CharsRef other)

Parameters

Type	Name	Description
CharsRef	other

Returns

Type	Description
CharsRef

Equals(Object)

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
System.Object	other

Returns

Type	Description
System.Boolean

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

Grow(Int32)

Used to grow the reference array.

In general this should not be used as it does not take the offset into account.

This is a Lucene.NET INTERNAL API, use at your own risk

Declaration

public void Grow(int newLength)

Parameters

Type	Name	Description
System.Int32	newLength

IsValid()

Performs internal consistency checks. Always returns true (or throws System.InvalidOperationException)

Declaration

public bool IsValid()

Returns

Type	Description
System.Boolean

Subsequence(Int32, Int32)

Declaration

public ICharSequence Subsequence(int startIndex, int length)

Parameters

Type	Name	Description
System.Int32	startIndex
System.Int32	length

Returns

Type	Description
J2N.Text.ICharSequence

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

Explicit Interface Implementations

ICharSequence.HasValue

Declaration

bool ICharSequence.HasValue { get; }

Returns

Type	Description
System.Boolean

IEquatable<CharsRef>.Equals(CharsRef)

Declaration

bool IEquatable<CharsRef>.Equals(CharsRef other)

Parameters

Type	Name	Description
CharsRef	other

Returns

Type	Description
System.Boolean

Implements

System.IComparable<T>

J2N.Text.ICharSequence

System.IEquatable<T>