Class MutableValue

Base class for all mutable values.

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Inheritance

object

MutableValue

MutableValueBool

MutableValueDouble

MutableValueInt32

MutableValueInt64

MutableValueSingle

MutableValueStr

Implements

IComparable<MutableValue>

IComparable

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Util.Mutable

Assembly: Lucene.Net.dll

Syntax

public abstract class MutableValue : IComparable<MutableValue>, IComparable

Constructors

MutableValue()

Base class for all mutable values.

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration

protected MutableValue()

Properties

Exists

Base class for all mutable values.

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration

public bool Exists { get; set; }

Property Value

Type	Description
bool

Methods

CompareSameType(object)

Base class for all mutable values.

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration

public abstract int CompareSameType(object other)

Parameters

Type	Name	Description
object	other

Returns

Type	Description
int

CompareTo(MutableValue)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Declaration

public virtual int CompareTo(MutableValue other)

Parameters

Type	Name	Description
MutableValue	other	An object to compare with this instance.

Returns

Type	Description
int	A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes other in the sort order. Zero This instance occurs in the same position in the sort order as other. Greater than zero This instance follows other in the sort order.

CompareTo(object)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Declaration

public virtual int CompareTo(object other)

Parameters

Type	Name	Description
object	other

Returns

Type	Description
int	A value that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes obj in the sort order. Zero This instance occurs in the same position in the sort order as obj. Greater than zero This instance follows obj in the sort order.

Exceptions

Type	Condition
ArgumentException	obj is not the same type as this instance.

Copy(MutableValue)

Base class for all mutable values.

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration

public abstract void Copy(MutableValue source)

Parameters

Type	Name	Description
MutableValue	source

Duplicate()

Base class for all mutable values.

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration

public abstract MutableValue Duplicate()

Returns

Type	Description
MutableValue

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
object	other

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

object.Equals(object)

EqualsSameType(object)

Base class for all mutable values.

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration

public abstract bool EqualsSameType(object other)

Parameters

Type	Name	Description
object	other

Returns

Type	Description
bool

GetHashCode()

Serves as the default hash function.

Declaration

public override abstract int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

object.GetHashCode()

ToObject()

Base class for all mutable values.

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration

public abstract object ToObject()

Returns

Type	Description
object

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents the current object.

Overrides

object.ToString()

Implements

IComparable<T>

IComparable