KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > views > markers > internal > MarkerNode


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/

11
12 package org.eclipse.ui.views.markers.internal;
13
14 /**
15  * The MarkerNode class is the class that handles category nodes and
16  * concrete markers.
17  *
18  */

19 public abstract class MarkerNode {
20
21     /**
22      * Get the children of the node.
23      * @return MarkerNode[]
24      */

25     public abstract MarkerNode[] getChildren();
26
27     /**
28      * Return the parent node or <code>null</code> if this is a top
29      * level element.
30      * @return MarkerNode
31      */

32     public abstract MarkerNode getParent() ;
33
34     /**
35      * Return whether or not this is a concrete node
36      * @return boolean
37      */

38     public abstract boolean isConcrete();
39
40     /**
41      * Return the description of the receiver.
42      * @return String
43      */

44     public abstract String JavaDoc getDescription() ;
45
46     /**
47      * Get a concrete marker from the receiver. If the receiver
48      * is concrete return the receiver otherwise return one of the
49      * concrete markers it contains.
50      * @return ConcreteMarker
51      */

52     public abstract ConcreteMarker getConcreteRepresentative();
53     
54
55 }
56
Popular Tags