IAttribute


1   /*******************************************************************************
2    * Copyright (c) 2002, 2005 Object Factory Inc.
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    *      Object Factory Inc. - Initial implementation
10   *******************************************************************************/
11  package org.eclipse.ant.internal.ui.dtd;
12  
13  /**
14   * Schema attribute interface.
15   * @author Bob Foster
16   */
17  public interface IAttribute extends IAtom {
18  
19      public static final String   CDATA = "CDATA"; //$NON-NLS-1$
20      public static final String   ID = "ID"; //$NON-NLS-1$
21      public static final String   IDREF = "IDREF"; //$NON-NLS-1$
22      public static final String   IDREFS = "IDREFS"; //$NON-NLS-1$
23      public static final String   NMTOKEN = "NMTOKEN"; //$NON-NLS-1$
24      public static final String   NMTOKENS = "NMTOKENS"; //$NON-NLS-1$
25      public static final String   ENTITY = "ENTITY"; //$NON-NLS-1$
26      public static final String   ENTITIES = "ENTITIES"; //$NON-NLS-1$
27      public static final String   NOTATION = "NOTATION"; //$NON-NLS-1$
28      public static final String   ENUMERATION = "enumeration"; //$NON-NLS-1$
29      
30      /**
31       * @return the attribute type. This will be one of "CDATA", "ID", "IDREF",
32       * "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", "NOTATION" or
33       * "enumeration". The type is interned and may be compared to a constant
34       * with ==. For "NOTATION" or "enumeration", <code>getEnum()</code> will
35       * return a list of values.
36       */
37      public String   getType();
38      
39      /**
40       * 
41       * @return String[] or null if type is not "NOTATION" or "ENUMERATION".
42       */
43      public String  [] getEnum();
44      
45      /**
46       * Return the element the attribute is defined in.
47       */
48      public IElement getElement();
49      
50      /**
51       * Return the default value or null if none.
52       */
53      public String   getDefault();
54      
55      /**
56       * Return true if the default value is fixed.
57       */
58      public boolean isFixed();
59      
60      /**
61       * Return true if attribute is required, false if it is optional.
62       */
63      public boolean isRequired();
64  }
65
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags