KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jdt > core > dom > SimplePropertyDescriptor


1 /*******************************************************************************
2  * Copyright (c) 2004, 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 package org.eclipse.jdt.core.dom;
12
13 /**
14  * Descriptor for a simple property of an AST node.
15  * A simple property is one whose value is a
16  * primitive type (such as <code>int</code> or <code>boolean</code>)
17  * or some simple value type (such as <code>String</code> or
18  * <code>InfixExpression.Operator</code>).
19  *
20  * @see org.eclipse.jdt.core.dom.ASTNode#getStructuralProperty(StructuralPropertyDescriptor)
21  * @see org.eclipse.jdt.core.dom.ASTNode#setStructuralProperty(StructuralPropertyDescriptor, Object)
22  * @since 3.0
23  */
24 public final class SimplePropertyDescriptor extends StructuralPropertyDescriptor {
25     
26     /**
27      * Value type. For example, for a node type like
28      * SingleVariableDeclaration, the modifiers property is int.class
29      */
30     private final Class JavaDoc valueType;
31     
32     /**
33      * Indicates whether a value is mandatory. A property value is allowed
34      * to be <code>null</code> only if it is not mandatory.
35      */
36     private final boolean mandatory;
37     
38     /**
39      * Creates a new simple property descriptor with the given property id.
40      * Note that this constructor is declared package-private so that
41      * property descriptors can only be created by the AST
42      * implementation.
43      *
44      * @param nodeClass concrete AST node type that owns this property
45      * @param propertyId the property id
46      * @param valueType the value type of this property
47      * @param mandatory <code>true</code> if the property is mandatory,
48      * and <code>false</code> if it is may be <code>null</code>
49      */
50     SimplePropertyDescriptor(Class JavaDoc nodeClass, String JavaDoc propertyId, Class JavaDoc valueType, boolean mandatory) {
51         super(nodeClass, propertyId);
52         if (valueType == null || ASTNode.class.isAssignableFrom(valueType)) {
53             throw new IllegalArgumentException JavaDoc();
54         }
55         this.valueType = valueType;
56         this.mandatory = mandatory;
57     }
58     
59     /**
60      * Returns the value type of this property.
61      * <p>
62      * For example, for a node type like SingleVariableDeclaration,
63      * the "modifiers" property returns <code>int.class</code>.
64      * </p>
65      *
66      * @return the value type of the property
67      */
68     public Class JavaDoc getValueType() {
69         return this.valueType;
70     }
71     
72     /**
73      * Returns whether this property is mandatory. A property value
74      * is not allowed to be <code>null</code> if it is mandatory.
75      *
76      * @return <code>true</code> if the property is mandatory,
77      * and <code>false</code> if it is may be <code>null</code>
78      */
79     public boolean isMandatory() {
80         return this.mandatory;
81     }
82 }
83
Popular Tags