net.sf.saxon.query

Class AnnotationList

java.lang.Object

net.sf.saxon.query.AnnotationList

All Implemented Interfaces:

java.lang.Iterable<Annotation>

public class AnnotationList
extends java.lang.Object
implements java.lang.Iterable<Annotation>

A list of function or variable annotations, or of annotation assertions

Field Summary

Fields

Modifier and Type	Field and Description
static AnnotationList	EMPTY

Constructor Summary

Constructors

Constructor and Description
AnnotationList(java.util.List<Annotation> list)

Method Summary

Modifier and Type	Method and Description
void	check(Configuration config, java.lang.String where) Check an annotation list for internal consistency (e.g.
boolean	equals(java.lang.Object other)
AnnotationList	filterByNamespace(java.lang.String ns)
Annotation	get(int i)
int	hashCode()
boolean	includes(java.lang.String localName) Ask whether a list of annotations contains an annotation with a given local name
boolean	includes(StructuredQName name) Ask whether a list of annotations contains an annotation with a given name
boolean	isEmpty()
java.util.Iterator<Annotation>	iterator() Returns an iterator over a set of elements of type T.
static AnnotationList	singleton(Annotation ann)
int	size()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

EMPTY

public static AnnotationList EMPTY

Constructor Detail

AnnotationList

public AnnotationList(java.util.List<Annotation> list)

Method Detail

singleton

public static AnnotationList singleton(Annotation ann)

check

public void check(Configuration config,
                  java.lang.String where)
           throws XPathException

Check an annotation list for internal consistency (e.g. rules that %public and %private cannot coexist)

Parameters:

where - the context where the list appears: one of "DF" (declare function), "DV" (declare variable), "IF" (inline function declaration), "FT" (function test)

Throws:

XPathException - if the annotation list is not internally consistent

filterByNamespace

public AnnotationList filterByNamespace(java.lang.String ns)

iterator

public java.util.Iterator<Annotation> iterator()

Returns an iterator over a set of elements of type T.

Specified by:

iterator in interface java.lang.Iterable<Annotation>

Returns:

an Iterator.

isEmpty

public boolean isEmpty()

size

public int size()

get

public Annotation get(int i)

includes

public boolean includes(StructuredQName name)

Ask whether a list of annotations contains an annotation with a given name

Parameters:

name - the given name

Returns:

true if one or more annotations with the given name are present in the list

includes

public boolean includes(java.lang.String localName)

Ask whether a list of annotations contains an annotation with a given local name

Parameters:

localName - the given local name

Returns:

true if one or more annotations with the given name are present in the list

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object