Class Attributes2

SAX2 extension helper for additional Attributes information, implementing the Attributes2 interface.

Inheritance
System.Object
Attributes
Attributes2
Inherited Members
Namespace: Sax.Ext
Assembly: Lucene.Net.Benchmark.dll
Syntax
public class Attributes2 : Attributes, IAttributes2, IAttributes
Remarks

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY.

This is not part of core-only SAX2 distributions.

The specified flag for each attribute will always be true, unless it has been set to false in the copy constructor or using SetSpecified(Int32, Boolean). Similarly, the declared flag for each attribute will always be false, except for defaulted attributes (specified is false), non-CDATA attributes, or when it is set to true using SetDeclared(Int32, Boolean). If you change an attribute's type by hand, you may need to modify its declared flag to match.

Constructors

| Improve this Doc View Source

Attributes2()

Construct a new, empty Attributes2 object.

Declaration
public Attributes2()
| Improve this Doc View Source

Attributes2(IAttributes)

Copy an existing Attributes or Attributes2 object. If the object implements Attributes2, values of the specified and declared flags for each attribute are copied. Otherwise the flag values are defaulted to assume no DTD was used, unless there is evidence to the contrary (such as attributes with type other than CDATA, which must have been declared).

This constructor is especially useful inside a StartElement(String, String, String, IAttributes) event.

Declaration
public Attributes2(IAttributes atts)
Parameters
Type Name Description
IAttributes atts

The existing IAttributes object.

Methods

| Improve this Doc View Source

AddAttribute(String, String, String, String, String)

Add an attribute to the end of the list, setting its "specified" flag to true. To set that flag's value to false, use SetSpecified(Int32, Boolean).

Unless the attribute type is CDATA, this attribute is marked as being declared in the DTD. To set that flag's value to true for CDATA attributes, use SetDeclared(Int32, Boolean).

Declaration
public override void AddAttribute(string uri, string localName, string qName, string type, string value)
Parameters
Type Name Description
System.String uri
System.String localName
System.String qName
System.String type
System.String value
Overrides
See Also
AddAttribute(System.String, System.String, System.String, System.String, System.String)
| Improve this Doc View Source

IsDeclared(Int32)

Returns the current value of the attribute's "declared" flag.

Declaration
public bool IsDeclared(int index)
Parameters
Type Name Description
System.Int32 index
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsDeclared(String)

Returns the current value of the attribute's "declared" flag.

Declaration
public bool IsDeclared(string qName)
Parameters
Type Name Description
System.String qName
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsDeclared(String, String)

Returns the current value of the attribute's "declared" flag.

Declaration
public bool IsDeclared(string uri, string localName)
Parameters
Type Name Description
System.String uri
System.String localName
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsSpecified(Int32)

Returns the current value of an attribute's "specified" flag.

Declaration
public bool IsSpecified(int index)
Parameters
Type Name Description
System.Int32 index

The attribute index (zero-based).
Returns
Type Description
System.Boolean

current flag value
| Improve this Doc View Source

IsSpecified(String)

Returns the current value of an attribute's "specified" flag.

Declaration
public bool IsSpecified(string qName)
Parameters
Type Name Description
System.String qName

The XML qualified (prefixed) name.
Returns
Type Description
System.Boolean

current flag value
| Improve this Doc View Source

IsSpecified(String, String)

Returns the current value of an attribute's "specified" flag.

Declaration
public bool IsSpecified(string uri, string localName)
Parameters
Type Name Description
System.String uri

The Namespace URI, or the empty string if the name has no Namespace URI.
System.String localName

The attribute's local name.
Returns
Type Description
System.Boolean

current flag value
| Improve this Doc View Source

RemoveAttribute(Int32)

Declaration
public override void RemoveAttribute(int index)
Parameters
Type Name Description
System.Int32 index
Overrides
| Improve this Doc View Source

SetAttributes(IAttributes)

Copy an entire Attributes object. The "specified" flags are assigned as true, and "declared" flags as false (except when an attribute's type is not CDATA), unless the object is an Attributes2 object. In that case those flag values are all copied.

Declaration
public override void SetAttributes(IAttributes atts)
Parameters
Type Name Description
IAttributes atts
Overrides
See Also
| Improve this Doc View Source

SetDeclared(Int32, Boolean)

Assign a value to the "declared" flag of a specific attribute. This is normally needed only for attributes of type CDATA, including attributes whose type is changed to or from CDATA.

Declaration
public virtual void SetDeclared(int index, bool value)
Parameters
Type Name Description
System.Int32 index

The index of the attribute (zero-based).
System.Boolean value

The desired flag value.
| Improve this Doc View Source

SetSpecified(Int32, Boolean)

Assign a value to the "specified" flag of a specific attribute. This is the only way this flag can be cleared, except clearing by initialization with the copy constructor.

Declaration
public virtual void SetSpecified(int index, bool value)
Parameters
Type Name Description
System.Int32 index

The index of the attribute (zero-based).
System.Boolean value

The desired flag value.

Implements