Class Attributes2

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

Inheritance

System.Object

Attributes

Attributes2

Implements

IAttributes2

IAttributes

Inherited Members

Attributes.Length

Attributes.GetURI(Int32)

Attributes.GetLocalName(Int32)

Attributes.GetQName(Int32)

Attributes.GetType(Int32)

Attributes.GetValue(Int32)

Attributes.GetIndex(String, String)

Attributes.GetIndex(String)

Attributes.GetType(String, String)

Attributes.GetType(String)

Attributes.GetValue(String, String)

Attributes.GetValue(String)

Attributes.Clear()

Attributes.SetAttribute(Int32, String, String, String, String, String)

Attributes.SetURI(Int32, String)

Attributes.SetLocalName(Int32, String)

Attributes.SetQName(Int32, String)

Attributes.SetType(Int32, String)

Attributes.SetValue(Int32, String)

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

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

Attributes2()

Construct a new, empty Attributes2 object.

Declaration

public Attributes2()

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

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

Attributes.AddAttribute(String, String, String, String, String)

See Also

AddAttribute(System.String, System.String, System.String, System.String, System.String)

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

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

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

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

Exceptions

Type	Condition
System.IndexOutOfRangeException	When the supplied index does not identify an attribute.

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

Exceptions

Type	Condition
System.ArgumentException	When the supplied name does not identify an attribute.

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

Exceptions

Type	Condition
System.ArgumentException	When the supplied names do not identify an attribute.

RemoveAttribute(Int32)

Declaration

public override void RemoveAttribute(int index)

Parameters

Type	Name	Description
System.Int32	index

Overrides

Attributes.RemoveAttribute(Int32)

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

Attributes.SetAttributes(IAttributes)

See Also

SetAttributes(IAttributes)

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.

Exceptions

Type	Condition
System.IndexOutOfRangeException	When the supplied index does not identify an attribute.

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.

Exceptions

Type	Condition
System.IndexOutOfRangeException	When the supplied index does not identify an attribute.

Implements

IAttributes2

IAttributes