| /******************************************************************************* |
| * Copyright (c) 2011 Oracle. All rights reserved. |
| * This program and the accompanying materials are made available under the |
| * terms of the Eclipse Public License v1.0, which accompanies this distribution |
| * and is available at http://www.eclipse.org/legal/epl-v10.html. |
| * |
| * Contributors: |
| * Oracle - initial API and implementation |
| ******************************************************************************/ |
| package org.eclipse.jpt.common.core.resource.java; |
| |
| import org.eclipse.jpt.common.utility.internal.iterables.ListIterable; |
| |
| /** |
| * Java source code or binary attribute (field/method) |
| * |
| * Provisional API: This interface is part of an interim API that is still |
| * under development and expected to change significantly before reaching |
| * stability. It is available at this early stage to solicit feedback from |
| * pioneering adopters on the understanding that any code that uses this API |
| * will almost certainly be broken (repeatedly) as the API evolves. |
| * |
| * @version 3.0 |
| * @since 3.0 |
| */ |
| public interface JavaResourceAttribute |
| extends JavaResourceMember |
| { |
| JavaResourceType getParent(); |
| |
| JavaResourceType getResourceType(); |
| |
| /** |
| * Return whether the attribute's type implements or extends the specified |
| * type. |
| */ |
| boolean typeIsSubTypeOf(String typeName); |
| |
| /** |
| * Return whether the attribute's type is a "variable" primitive type |
| * (i.e. any primitive type except 'void'). |
| */ |
| boolean typeIsVariablePrimitive(); |
| |
| /** |
| * @see java.lang.reflect.Modifier |
| */ |
| int getModifiers(); |
| String MODIFIERS_PROPERTY = "modifiers"; //$NON-NLS-1$ |
| |
| /** |
| * Return the resolved, qualified name of the attribute's type |
| * (e.g. "java.util.Collection" or "byte[]"). |
| * If the type is an array, this name will include the appropriate number |
| * of bracket pairs. |
| * This name will not include the type's generic type arguments |
| * (e.g. "java.util.Collection<java.lang.String>" will only return |
| * "java.util.Collection"). |
| * @see #getTypeTypeArgumentNames() |
| */ |
| String getTypeName(); |
| String TYPE_NAME_PROPERTY = "typeName"; //$NON-NLS-1$ |
| |
| /** |
| * Return whether the attribute type is an interface. |
| */ |
| boolean typeIsInterface(); |
| String TYPE_IS_INTERFACE_PROPERTY = "typeIsInterface"; //$NON-NLS-1$ |
| |
| /** |
| * Return whether the attribute type is an enum. |
| */ |
| boolean typeIsEnum(); |
| String TYPE_IS_ENUM_PROPERTY = "typeIsEnum"; //$NON-NLS-1$ |
| |
| /** |
| * Return whether the attribute type is an array. |
| */ |
| boolean typeIsArray(); |
| String TYPE_IS_ARRAY_PROPERTY = "typeIsArray"; //$NON-NLS-1$ |
| |
| /** |
| * Return the dimensionality of the array, 0 otherwise. |
| * (String[][] -> 2, Collection<String> -> 0) |
| */ |
| int getTypeArrayDimensionality(); |
| String TYPE_ARRAY_DIMENSIONALITY_PROPERTY = "typeArrayDimensionality"; //$NON-NLS-1$ |
| |
| /** |
| * Return the component type name of the array, null otherwise. |
| * (String[][] -> "java.lang.String", Collection<String> -> null) |
| */ |
| String getTypeArrayComponentTypeName(); |
| String TYPE_ARRAY_COMPONENT_TYPE_NAME_PROPERTY = "typeArrayComponentTypeName"; //$NON-NLS-1$ |
| |
| /** |
| * Return the names of the attribute type's superclasses. |
| */ |
| ListIterable<String> getTypeSuperclassNames(); |
| String TYPE_SUPERCLASS_NAMES_LIST = "typeSuperclassNames"; //$NON-NLS-1$ |
| |
| /** |
| * Return the names of the attribute type's interfaces. |
| */ |
| Iterable<String> getTypeInterfaceNames(); |
| String TYPE_INTERFACE_NAMES_COLLECTION = "typeInterfaceNames"; //$NON-NLS-1$ |
| |
| /** |
| * Return the names of the attribute type's type arguments. |
| * The name for any argument that is an array will contain the appropriate |
| * number of bracket pairs. |
| * The names will not include any further generic type arguments. |
| */ |
| ListIterable<String> getTypeTypeArgumentNames(); |
| String TYPE_TYPE_ARGUMENT_NAMES_LIST = "typeTypeArgumentNames"; //$NON-NLS-1$ |
| |
| int getTypeTypeArgumentNamesSize(); |
| |
| String getTypeTypeArgumentName(int index); |
| |
| } |