com.github.javaparser.symbolsolver.resolution.typesolvers

Class JarTypeSolver

java.lang.Object

com.github.javaparser.symbolsolver.resolution.typesolvers.JarTypeSolver

All Implemented Interfaces:

TypeSolver

public class JarTypeSolver
extends Object
implements TypeSolver

Will let the symbol solver look inside a jar file while solving types.

Author:

Federico Tomassetti

Field Summary

Fields inherited from interface com.github.javaparser.resolution.TypeSolver

JAVA_LANG_OBJECT, JAVA_LANG_RECORD

Constructor Summary

Constructors

Constructor and Description
JarTypeSolver(File pathToJarOrClassFileHierarchy) Create a JarTypeSolver from a File.
JarTypeSolver(InputStream jarInputStream) Create a JarTypeSolver from a InputStream.
JarTypeSolver(Path pathToJarOrClassFileHierarchy) Create a JarTypeSolver from a Path.
JarTypeSolver(String pathToJarOrClassFileHierarchy) Create a JarTypeSolver from a path in a String format.

Method Summary

Modifier and Type	Method and Description
static JarTypeSolver	getJarTypeSolver(String pathToJar) Deprecated. Use of this static method (previously following singleton pattern) is strongly discouraged and will be removed in a future version. For now, it has been modified to return a new instance to prevent the IllegalStateException being thrown (as reported in #2547), allowing it to be called multiple times.
Set<String>	getKnownClasses() Get the set of classes that can be resolved in the current type solver.
TypeSolver	getParent()
void	setParent(TypeSolver parent)
ResolvedReferenceTypeDeclaration	solveType(String name)
SymbolReference<ResolvedReferenceTypeDeclaration>	tryToSolveType(String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.github.javaparser.resolution.TypeSolver

getRoot, getSolvedJavaLangObject, getSolvedJavaLangRecord, hasType

Constructor Detail

JarTypeSolver

public JarTypeSolver(Path pathToJarOrClassFileHierarchy)
              throws IOException

Create a JarTypeSolver from a Path.

Parameters:

pathToJarOrClassFileHierarchy - The path where the jar or class file hierarchy is located.

Throws:

IOException - If an I/O exception occurs while reading the Jar or class file hierarchy.

JarTypeSolver

public JarTypeSolver(File pathToJarOrClassFileHierarchy)
              throws IOException

Create a JarTypeSolver from a File.

Parameters:

pathToJarOrClassFileHierarchy - The file pointing to the jar or class file hierarchy is located.

Throws:

IOException - If an I/O exception occurs while reading the Jar or class file hierarchy.

JarTypeSolver

public JarTypeSolver(String pathToJarOrClassFileHierarchy)
              throws IOException

Create a JarTypeSolver from a path in a String format.

Parameters:

pathToJarOrClassFileHierarchy - The path pointing to the jar or class file hierarchy.

Throws:

IOException - If an I/O exception occurs while reading the Jar or class file hierarchy.

JarTypeSolver

public JarTypeSolver(InputStream jarInputStream)
              throws IOException

Create a JarTypeSolver from a InputStream. The content will be dumped into a temporary file to be used in the type solver.

Parameters:

jarInputStream - The input stream to be used.

Throws:

IOException - If an I/O exception occurs while creating the temporary file.

Method Detail

getJarTypeSolver

@Deprecated
public static JarTypeSolver getJarTypeSolver(String pathToJar)
                                                   throws IOException

Deprecated. Use of this static method (previously following singleton pattern) is strongly discouraged and will be removed in a future version. For now, it has been modified to return a new instance to prevent the IllegalStateException being thrown (as reported in #2547), allowing it to be called multiple times.

Throws:

IOException

getKnownClasses

public Set<String> getKnownClasses()

Get the set of classes that can be resolved in the current type solver.

Returns:

The set of known classes.

getParent

public TypeSolver getParent()

Specified by:

getParent in interface TypeSolver

setParent

public void setParent(TypeSolver parent)

Specified by:

setParent in interface TypeSolver

tryToSolveType

public SymbolReference<ResolvedReferenceTypeDeclaration> tryToSolveType(String name)

Specified by:

tryToSolveType in interface TypeSolver

solveType

public ResolvedReferenceTypeDeclaration solveType(String name)
                                           throws UnsolvedSymbolException

Specified by:

solveType in interface TypeSolver

Throws:

UnsolvedSymbolException