com.github.javaparser.resolution.model.SymbolReference Maven / Gradle / Ivy
/*
* Copyright (C) 2015-2016 Federico Tomassetti
* Copyright (C) 2017-2023 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.model;
import java.util.Optional;
import com.github.javaparser.quality.Nullable;
import com.github.javaparser.resolution.UnsolvedSymbolException;
import com.github.javaparser.resolution.declarations.ResolvedDeclaration;
/**
* A reference to a symbol. It can solved or not solved. If solved the corresponding
* declaration will be provided.
*
* @author Federico Tomassetti
*/
public class SymbolReference {
/**
* Create a solve reference to the given symbol.
*/
public static SymbolReference solved(S2 symbolDeclaration) {
return new SymbolReference<>(symbolDeclaration);
}
/**
* Create a reference for an unsolved symbol.
*
* @return The created unsolved symbol reference.
*
* @param The symbol reference type.
*/
public static SymbolReference unsolved() {
return new SymbolReference<>(null);
}
/**
* Create an unsolved reference specifying the type of the value expected.
*
* @deprecated Consider using {@link #unsolved()} instead.
*/
@Deprecated
public static SymbolReference unsolved(Class clazz) {
return unsolved();
}
/**
* Adapt a {@link SymbolReference} into another {@link SymbolReference}.
*
* @param ref The reference to be adapted.
* @param clazz The final type to be used.
*
* @return The adapted symbol reference.
*
* @param The Symbol Reference before adapting.
* @param The Symbol Reference after adapting.
*/
public static SymbolReference adapt(SymbolReference ref, Class clazz) {
Optional declaration = ref.getDeclaration();
if (declaration.isPresent()) {
I symbol = declaration.get();
if (clazz.isInstance(symbol)) {
return solved(clazz.cast(symbol));
}
}
return unsolved();
}
private final S correspondingDeclaration;
private SymbolReference(@Nullable S correspondingDeclaration) {
this.correspondingDeclaration = correspondingDeclaration;
}
/**
* Get the declaration associated with the Symbol.
*
* @return an {@link Optional} with a present value if the symbol is solved, otherwise an empty {@link Optional}.
*/
public Optional getDeclaration() {
return Optional.ofNullable(correspondingDeclaration);
}
/**
* The corresponding declaration. If not solve this throws UnsupportedOperationException.
*/
public S getCorrespondingDeclaration() {
Optional declaration = getDeclaration();
if (declaration.isPresent()) {
return declaration.get();
}
throw new UnsolvedSymbolException("Corresponding declaration not available for unsolved symbol.");
}
/**
* Is the reference solved?
*/
public boolean isSolved() {
return getDeclaration().isPresent();
}
@Override
public String toString() {
return "SymbolReference{" + correspondingDeclaration + "}";
}
}