Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class KeywordAttribute

    Default implementation of IKeywordAttribute.

    Inheritance
    object
    Attribute
    KeywordAttribute
    Implements
    IKeywordAttribute
    IAttribute
    Inherited Members
    Attribute.ReflectAsString(bool)
    Attribute.ReflectWith(IAttributeReflector)
    Attribute.ToString()
    Attribute.Clone()
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Analysis.TokenAttributes
    Assembly: Lucene.Net.dll
    Syntax
    public sealed class KeywordAttribute : Attribute, IKeywordAttribute, IAttribute

    Constructors

    KeywordAttribute()

    Initialize this attribute with the keyword value as false.

    Declaration
    public KeywordAttribute()

    Properties

    IsKeyword

    Gets or Sets whether the current token is a keyword. true if the current token is a keyword, otherwise false.

    Declaration
    public bool IsKeyword { get; set; }
    Property Value
    Type Description
    bool

    Methods

    Clear()

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

    Declaration
    public override void Clear()
    Overrides
    Attribute.Clear()

    CopyTo(IAttribute)

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

    Declaration
    public override void CopyTo(IAttribute target)
    Parameters
    Type Name Description
    IAttribute target
    Overrides
    Attribute.CopyTo(IAttribute)

    Equals(object)

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

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    object obj

    The object to compare with the current object.

    Returns
    Type Description
    bool

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

    Overrides
    object.Equals(object)

    GetHashCode()

    Serves as the default hash function.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int

    A hash code for the current object.

    Overrides
    object.GetHashCode()

    Implements

    IKeywordAttribute
    IAttribute
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.