Class AttributeImpl

    • Field Detail

      • enableBackwards

        @Deprecated
        protected boolean enableBackwards
        Deprecated.
        this will be removed in Lucene 4.0.
        When true (default), if a subclass overrides toString(), its output is parsed by reflectWith(org.apache.lucene.util.AttributeReflector) and used for attribute reflection. This is added to enable attribute implementations from Lucene 2.9 or 3.0 to work correctly with reflection.
    • Constructor Detail

      • AttributeImpl

        public AttributeImpl()
    • Method Detail

      • clear

        public abstract 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.
      • toString

        public String toString()
        Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object.

        WARNING: For backwards compatibility this method is implemented as return reflectAsString(false). In Lucene 4.0 this default implementation will be removed. The reason for this is the problem of CharTermAttributeImpl.toString() that must return a string representation of the term's char sequence.

        It is recommeneded to use reflectAsString(boolean) or reflectWith(org.apache.lucene.util.AttributeReflector) to get a well-defined output of AttributeImpl's internals.

        Overrides:
        toString in class Object
      • reflectAsString

        public final String reflectAsString​(boolean prependAttClass)
        This method returns the current attribute values as a string in the following format by calling the reflectWith(AttributeReflector) method:
        • iff prependAttClass=true: "AttributeClass#key=value,AttributeClass#key=value"
        • iff prependAttClass=false: "key=value,key=value"
        See Also:
        reflectWith(AttributeReflector), toString()
      • copyTo

        public abstract void copyTo​(AttributeImpl target)
        Copies the values from this Attribute into the passed-in target attribute. The target implementation must support all the Attributes this implementation supports.
      • clone

        public Object clone()
        Shallow clone. Subclasses must override this if they need to clone any members deeply,
        Overrides:
        clone in class Object