Class StoredField

A field whose value is stored so that Doc(int) and Document(int) will return the field and its value.

Inheritance
object
Field
StoredField
Inherited Members
Namespace: Lucene.Net.Documents
Assembly: Lucene.Net.dll
Syntax
public sealed class StoredField : Field, IIndexableField, IFormattable

Constructors

StoredField(string, BytesRef)

Create a stored-only field with the given binary value.

NOTE: the provided BytesRef is not copied so be sure not to change it until you're done with this field.

Declaration
public StoredField(string name, BytesRef value)
Parameters
Type Name Description
string name

field name
BytesRef value

BytesRef pointing to binary content (not copied)
Exceptions
Type Condition
ArgumentNullException

if the field name is null.

StoredField(string, byte[])

Create a stored-only field with the given binary value.

NOTE: the provided byte[] is not copied so be sure not to change it until you're done with this field.

Declaration
public StoredField(string name, byte[] value)
Parameters
Type Name Description
string name

field name
byte[] value

byte array pointing to binary content (not copied)
Exceptions
Type Condition
ArgumentNullException

if the field name is null.

StoredField(string, byte[], int, int)

Create a stored-only field with the given binary value.

NOTE: the provided byte[] is not copied so be sure not to change it until you're done with this field.

Declaration
public StoredField(string name, byte[] value, int offset, int length)
Parameters
Type Name Description
string name

field name
byte[] value

byte array pointing to binary content (not copied)
int offset

starting position of the byte array
int length

valid length of the byte array
Exceptions
Type Condition
ArgumentNullException

if the field name is null.

StoredField(string, double)

Create a stored-only field with the given double value.

Declaration
public StoredField(string name, double value)
Parameters
Type Name Description
string name

field name
double value

double value
Exceptions
Type Condition
ArgumentNullException

if the field name is null.

StoredField(string, int)

Create a stored-only field with the given int value.

Declaration
public StoredField(string name, int value)
Parameters
Type Name Description
string name

field name
int value

int value
Exceptions
Type Condition
ArgumentNullException

if the field name is null.

StoredField(string, long)

Create a stored-only field with the given long value.

Declaration
public StoredField(string name, long value)
Parameters
Type Name Description
string name

field name
long value

long value
Exceptions
Type Condition
ArgumentNullException

if the field name is null.

StoredField(string, float)

Create a stored-only field with the given float value.

Declaration
public StoredField(string name, float value)
Parameters
Type Name Description
string name

field name
float value

float value
Exceptions
Type Condition
ArgumentNullException

if the field name is null.

StoredField(string, string)

Create a stored-only field with the given string value.

Declaration
public StoredField(string name, string value)
Parameters
Type Name Description
string name

field name
string value

string value
Exceptions
Type Condition
ArgumentNullException

if the field name or value is null.

Fields

TYPE

Type for a stored-only field.

Declaration
public static readonly FieldType TYPE
Field Value
Type Description
FieldType

Implements

Extension Methods