diff options
Diffstat (limited to 'javaparser-core/src/main/java/com/github/javaparser/resolution/declarations/ResolvedTypeDeclaration.java')
| -rw-r--r-- | javaparser-core/src/main/java/com/github/javaparser/resolution/declarations/ResolvedTypeDeclaration.java | 200 |
1 files changed, 200 insertions, 0 deletions
diff --git a/javaparser-core/src/main/java/com/github/javaparser/resolution/declarations/ResolvedTypeDeclaration.java b/javaparser-core/src/main/java/com/github/javaparser/resolution/declarations/ResolvedTypeDeclaration.java new file mode 100644 index 000000000..0b715fe29 --- /dev/null +++ b/javaparser-core/src/main/java/com/github/javaparser/resolution/declarations/ResolvedTypeDeclaration.java @@ -0,0 +1,200 @@ +/* + * Copyright (C) 2007-2010 Júlio Vilmar Gesser. + * Copyright (C) 2011, 2013-2016 The JavaParser Team. + * + * This file is part of JavaParser. + * + * JavaParser can be used either under the terms of + * a) the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * b) the terms of the Apache License + * + * You should have received a copy of both licenses in LICENCE.LGPL and + * LICENCE.APACHE. Please refer to those files for details. + * + * JavaParser is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + */ + +package com.github.javaparser.resolution.declarations; + +import com.github.javaparser.resolution.UnsolvedSymbolException; + +import java.util.Optional; +import java.util.Set; + +/** + * A declaration of a type. It could be a primitive type, an enum, a class, an interface + * or a type variable. + * It cannot be an annotation or an array. + * + * @author Federico Tomassetti + */ +public interface ResolvedTypeDeclaration extends ResolvedDeclaration { + + /// + /// Containment + /// + + /** + * Get the list of types defined inside the current type. + */ + default Set<ResolvedReferenceTypeDeclaration> internalTypes() { + throw new UnsupportedOperationException("InternalTypes not available for " + this.getClass().getCanonicalName()); + } + + /** + * Returns a type declaration for the internal type based on name. + * (Does not include internal types inside internal types). + */ + default ResolvedReferenceTypeDeclaration getInternalType(String name) { + Optional<ResolvedReferenceTypeDeclaration> type = + this.internalTypes().stream().filter(f -> f.getName().equals(name)).findFirst(); + return type.orElseThrow(() -> + new UnsolvedSymbolException("Internal type not found: " + name)); + } + + /** + * Does this type contain an internal type with the given name? + * (Does not include internal types inside internal types). + */ + default boolean hasInternalType(String name) { + return this.internalTypes().stream().anyMatch(f -> f.getName().equals(name)); + } + + /** + * Get the ReferenceTypeDeclaration enclosing this declaration. + * + * @return + */ + Optional<ResolvedReferenceTypeDeclaration> containerType(); + + /// + /// Misc + /// + + /** + * Is this the declaration of a class? + * Note that an Enum is not considered a Class in this case. + */ + default boolean isClass() { + return false; + } + + /** + * Is this the declaration of an interface? + */ + default boolean isInterface() { + return false; + } + + /** + * Is this the declaration of an enum? + */ + default boolean isEnum() { + return false; + } + + /** + * Is this the declaration of a type parameter? + */ + default boolean isTypeParameter() { + return false; + } + + @Override + default boolean isType() { + return true; + } + + /** + * Is this type declaration corresponding to an anonymous class? + * + * This is an example of anonymous class: + * <pre> + * HelloWorld frenchGreeting = new HelloWorld() { + * String name = "tout le monde"; + * + * public void greet() { + * greetSomeone("tout le monde"); + * } + * + * public void greetSomeone(String someone) { + * name = someone; + * System.out.println("Salut " + name); + * } + * }; + * </pre> + */ + default boolean isAnonymousClass() { + return false; + } + + @Override + default ResolvedTypeDeclaration asType() { + return this; + } + + /** + * Return this as a ClassDeclaration or throw UnsupportedOperationException. + */ + default ResolvedClassDeclaration asClass() { + throw new UnsupportedOperationException(String.format("%s is not a class", this)); + } + + /** + * Return this as a InterfaceDeclaration or throw UnsupportedOperationException. + */ + default ResolvedInterfaceDeclaration asInterface() { + throw new UnsupportedOperationException(String.format("%s is not an interface", this)); + } + + /** + * Return this as a EnumDeclaration or throw UnsupportedOperationException. + */ + default ResolvedEnumDeclaration asEnum() { + throw new UnsupportedOperationException(String.format("%s is not an enum", this)); + } + + /** + * Return this as a TypeParameterDeclaration or throw UnsupportedOperationException. + */ + default ResolvedTypeParameterDeclaration asTypeParameter() { + throw new UnsupportedOperationException(String.format("%s is not a type parameter", this)); + } + + default ResolvedReferenceTypeDeclaration asReferenceType() { + throw new UnsupportedOperationException(String.format("%s is not a reference type", this)); + } + + /** + * The package name of the type. + */ + String getPackageName(); + + /** + * The class(es) wrapping this type. + */ + String getClassName(); + + /** + * The fully qualified name of the type declared. + */ + String getQualifiedName(); + + /** + * The ID corresponds most of the type to the qualified name. It differs only for local + * classes which do not have a qualified name but have an ID. + */ + default String getId() { + String qname = getQualifiedName(); + if (qname == null) { + return String.format("<localClass>:%s", getName()); + } + return qname; + } + +} |