Lucene.Net.Analysis.Tokenattributes.FlagsAttribute Class Reference

This attribute can be used to pass different flags down the tokenizer chain, eg from one TokenFilter to another one. More...

Inherits Lucene.Net.Util.Attribute, Lucene.Net.Analysis.Tokenattributes.IFlagsAttribute, and ICloneable.

Public Member Functions
override void	Clear ()
	Clears the values in this AttributeImpl and resets it to its default value. If this implementation implements more than one Attribute interface it clears all.
override bool	Equals (System.Object other)
	All values used for computation of GetHashCode() should be checked here for equality.
override int	GetHashCode ()
	Subclasses must implement this method and should compute a hashCode similar to this:
override void	CopyTo (Attribute target)
	Copies the values from this Attribute into the passed-in target attribute. The target implementation must support all the Attributes this implementation supports.
override System.Object	Clone ()
	Shallow clone. Subclasses must override this if they need to clone any members deeply,
Public Member Functions inherited from Lucene.Net.Util.Attribute
override System.String	ToString ()
	The default implementation of this method accesses all declared fields of this object and prints the values in the following syntax:

Properties
virtual int	Flags [get, set]
	EXPERIMENTAL: While we think this is here to stay, we may want to change it to be a long.
Properties inherited from Lucene.Net.Analysis.Tokenattributes.IFlagsAttribute
int	Flags [get, set]
	EXPERIMENTAL: While we think this is here to stay, we may want to change it to be a long.

Detailed Description

This attribute can be used to pass different flags down the tokenizer chain, eg from one TokenFilter to another one.

Definition at line 28 of file FlagsAttribute.cs.

Member Function Documentation

override void Lucene.Net.Analysis.Tokenattributes.FlagsAttribute.Clear ( )

virtual

Clears the values in this AttributeImpl and resets it to its default value. If this implementation implements more than one Attribute interface it clears all.

Implements Lucene.Net.Util.Attribute.

Definition at line 47 of file FlagsAttribute.cs.

override System.Object Lucene.Net.Analysis.Tokenattributes.FlagsAttribute.Clone ( )

virtual

Shallow clone. Subclasses must override this if they need to clone any members deeply,

Reimplemented from Lucene.Net.Util.Attribute.

Definition at line 78 of file FlagsAttribute.cs.

override void Lucene.Net.Analysis.Tokenattributes.FlagsAttribute.CopyTo ( Attribute  target )

virtual

Copies the values from this Attribute into the passed-in target attribute. The target implementation must support all the Attributes this implementation supports.

Implements Lucene.Net.Util.Attribute.

Definition at line 72 of file FlagsAttribute.cs.

override bool Lucene.Net.Analysis.Tokenattributes.FlagsAttribute.Equals ( System.Object  other )

virtual

All values used for computation of GetHashCode() should be checked here for equality.

see also Object.Equals(Object)

Implements Lucene.Net.Util.Attribute.

Definition at line 52 of file FlagsAttribute.cs.

override int Lucene.Net.Analysis.Tokenattributes.FlagsAttribute.GetHashCode ( )

virtual

Subclasses must implement this method and should compute a hashCode similar to this:

public int hashCode() { int code = startOffset; code = code * 31 + endOffset; return code; }

see also Equals(Object)

Implements Lucene.Net.Util.Attribute.

Definition at line 67 of file FlagsAttribute.cs.

Property Documentation

virtual int Lucene.Net.Analysis.Tokenattributes.FlagsAttribute.Flags

getset

EXPERIMENTAL: While we think this is here to stay, we may want to change it to be a long.

Get the bitset for any bits that have been set. This is completely distinct from ITypeAttribute.Type(), although they do share similar purposes. The flags can be used to encode information about the token for use by other Lucene.Net.Analysis.TokenFilters.

The bits

Definition at line 42 of file FlagsAttribute.cs.

---

The documentation for this class was generated from the following file:

• core/Analysis/Tokenattributes/FlagsAttribute.cs