KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > fr > jayasoft > ivy > extendable > ExtendableItem


1 /*
2  * This file is subject to the licence found in LICENCE.TXT in the root directory of the project.
3  * Copyright Jayasoft 2005 - All rights reserved
4  *
5  * #SNAPSHOT#
6  */

7 package fr.jayasoft.ivy.extendable;
8
9 import java.util.Map JavaDoc;
10
11 public interface ExtendableItem {
12     /**
13      * Gets the value of an attribute
14      * Can be used to access the value of a standard attribute (like organisation, revision) or of an extra attribute.
15      * @param attName the name of the attribute to get
16      * @return the value of the attribute, null if the attribute doesn't exist
17      */

18     String JavaDoc getAttribute(String JavaDoc attName);
19     /**
20      * Gets the value of a standard attribute
21      * Can be used only to access the value of a standard attribute (like organisation, revision), not an extra one
22      * @param attName the name of the standard attribute to get
23      * @return the value of the attribute, null if the attribute doesn't exist
24      */

25     String JavaDoc getStandardAttribute(String JavaDoc attName);
26     /**
27      * Gets the value of an extra attribute
28      * Can be used only to access the value of an extra attribute, not a standard one (like organisation, revision)
29      * @param attName the name of the extra attribute to get
30      * @return the value of the attribute, null if the attribute doesn't exist
31      */

32     String JavaDoc getExtraAttribute(String JavaDoc attName);
33     
34     /**
35      * Returns a Map of all attributes of this extendable item, including standard and extra ones.
36      * The Map keys are attribute names as Strings, and values are corresponding attribute values (as String too)
37      * @return
38      */

39     Map JavaDoc getAttributes();
40     /**
41      * Returns a Map of all standard attributes of this extendable item.
42      * The Map keys are attribute names as Strings, and values are corresponding attribute values (as String too)
43      * @return
44      */

45     Map JavaDoc getStandardAttributes();
46     /**
47      * Returns a Map of all extra attributes of this extendable item.
48      * The Map keys are attribute names as Strings, and values are corresponding attribute values (as String too)
49      * @return
50      */

51     Map JavaDoc getExtraAttributes();
52 }
Popular Tags