KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > columba > core > scripting > extensions > AbstractExtensionPoint


1 /*
2   The contents of this file are subject to the Mozilla Public License Version 1.1
3   (the "License"); you may not use this file except in compliance with the
4   License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
5   
6   Software distributed under the License is distributed on an "AS IS" basis,
7   WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
8   for the specific language governing rights and
9   limitations under the License.
10
11   The Original Code is "The Columba Project"
12   
13   The Initial Developers of the Original Code are Frederik Dietz and Timo Stich.
14   Portions created by Frederik Dietz and Timo Stich are Copyright (C) 2003.
15   
16   All Rights Reserved.
17 */
18 package org.columba.core.scripting.extensions;
19
20
21
22 /**
23  
24   Abstract class for extension points. <br>
25   Developers should ensure that their Extension Points provide a unique identifier
26   and, if possible, make those identifiers easy to find.<br>
27   <br>
28   TODO maybe create a unique place to define extension point id's?
29   
30   @author Celso Pinto (cpinto@yimports.com)
31   
32  */
33 public abstract class AbstractExtensionPoint
34 {
35   /* TODO add javadocs */
36   
37   /**
38     Use to indicate that the action must be inserted at the beginning of the
39     action stack
40   */
41   public static final int POSITION_BEGINNING = 1 << 0;
42   
43   /**
44     Use to indicate that the action must be added at the end of the action
45     stack.
46   */
47   public static final int POSITION_END = 1 << 1;
48   
49   private String JavaDoc id = null;
50   
51   /**
52     Default constructor. Every extension point must garantee that it's identifier
53     is unique.
54     @param id the extension point identifier
55   */
56   public AbstractExtensionPoint(String JavaDoc id)
57   {
58     this.id = id;
59   }
60   
61   /**
62     Getter for the extension point id
63     @return the extension point id
64   */
65   public String JavaDoc getId()
66   {
67     return id;
68   }
69   
70 }
71
Popular Tags