Eclipse Plug-in Developer Guide (Galileo) - AnnotationBag (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jface.text.source.projection
Class AnnotationBag


java.lang.Object
  

org.eclipse.jface.text.source.Annotation
      
org.eclipse.jface.text.source.projection.AnnotationBag

public class AnnotationBag
extends Annotation
extends Annotation

A bag of annotations.

This class is not intended to be subclassed.

Since:: 3.0
Restriction:: This class is not intended to be subclassed by clients.

Field Summary

Fields inherited from class org.eclipse.jface.text.source. Annotation

TYPE_UNKNOWN

Constructor Summary

AnnotationBag ( String type)
          Creates a new annotation bag.

Method Summary

void add ( Annotation annotation)
          Adds the given annotation to the annotation bag.

boolean isEmpty ()
          Returns whether the annotation bag is empty.

Iterator iterator ()
          Returns an iterator for all annotation inside this annotation bag or null if the bag is empty.

void remove ( Annotation annotation)
          Removes the given annotation from the annotation bag.

Methods inherited from class org.eclipse.jface.text.source. Annotation

getText, getType, isMarkedDeleted, isPersistent, markDeleted, setText, setType

Methods inherited from class java.lang. Object

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

Constructor Detail

AnnotationBag

public AnnotationBag(
String type)

Creates a new annotation bag.

Parameters:: type - the annotation type

Method Detail

add

public void add(
Annotation annotation)

Adds the given annotation to the annotation bag.

Parameters:: annotation - the annotation to add

remove

public void remove(
Annotation annotation)

Removes the given annotation from the annotation bag.

Parameters:: annotation - the annotation to remove

isEmpty

public boolean isEmpty()

Returns whether the annotation bag is empty.

Returns:: true if the annotation bag is empty, false otherwise

iterator

public 
Iterator iterator()

Returns an iterator for all annotation inside this annotation bag or null if the bag is empty.

Returns:: an iterator for all annotations in the bag or null
Since:: 3.1