01: /*******************************************************************************
02: * Copyright (c) 2004, 2006 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.jdt.core.dom;
11:
12: /**
13: * Descriptor for a simple property of an AST node.
14: * A simple property is one whose value is a
15: * primitive type (such as <code>int</code> or <code>boolean</code>)
16: * or some simple value type (such as <code>String</code> or
17: * <code>InfixExpression.Operator</code>).
18: *
19: * @see org.eclipse.jdt.core.dom.ASTNode#getStructuralProperty(StructuralPropertyDescriptor)
20: * @see org.eclipse.jdt.core.dom.ASTNode#setStructuralProperty(StructuralPropertyDescriptor, Object)
21: * @since 3.0
22: */
23: public final class SimplePropertyDescriptor extends
24: 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 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 nodeClass, String propertyId,
51: Class valueType, boolean mandatory) {
52: super (nodeClass, propertyId);
53: if (valueType == null
54: || ASTNode.class.isAssignableFrom(valueType)) {
55: throw new IllegalArgumentException();
56: }
57: this .valueType = valueType;
58: this .mandatory = mandatory;
59: }
60:
61: /**
62: * Returns the value type of this property.
63: * <p>
64: * For example, for a node type like SingleVariableDeclaration,
65: * the "modifiers" property returns <code>int.class</code>.
66: * </p>
67: *
68: * @return the value type of the property
69: */
70: public Class getValueType() {
71: return this .valueType;
72: }
73:
74: /**
75: * Returns whether this property is mandatory. A property value
76: * is not allowed to be <code>null</code> if it is mandatory.
77: *
78: * @return <code>true</code> if the property is mandatory,
79: * and <code>false</code> if it is may be <code>null</code>
80: */
81: public boolean isMandatory() {
82: return this.mandatory;
83: }
84: }
|