Package 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.symbolsolver.model.resolution.TypeSolver

JAVA_LANG_OBJECT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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.
Set<String>	getKnownClasses()	Get the set of classes that can be resolved in the current type solver.
TypeSolver	getParent()	Parent of the this TypeSolver.
void	setParent(TypeSolver parent)	Set the parent of this TypeSolver.
ResolvedReferenceTypeDeclaration	solveType(String name)	Solve the given type.
SymbolReference<ResolvedReferenceTypeDeclaration>	tryToSolveType(String name)	Try to solve the type with the given 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.symbolsolver.model.resolution.TypeSolver

getRoot, getSolvedJavaLangObject, hasType

Constructor Details

JarTypeSolver

public JarTypeSolver(Path pathToJar)
              throws IOException

Create a JarTypeSolver from a Path.

Parameters:

pathToJar - The path where the jar is located.

Throws:

IOException - If an I/O exception occurs while reading the Jar.

JarTypeSolver

public JarTypeSolver(File pathToJar)
              throws IOException

Create a JarTypeSolver from a File.

Parameters:

pathToJar - The file pointing to the jar is located.

Throws:

IOException - If an I/O exception occurs while reading the Jar.

JarTypeSolver

public JarTypeSolver(String pathToJar)
              throws IOException

Create a JarTypeSolver from a path in a String format.

Parameters:

pathToJar - The path pointing to the jar.

Throws:

IOException - If an I/O exception occurs while reading the Jar.

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 Details

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()

Description copied from interface: TypeSolver

Parent of the this TypeSolver. This can return null.

Specified by:

getParent in interface TypeSolver

setParent

public void setParent(TypeSolver parent)

Description copied from interface: TypeSolver

Set the parent of this TypeSolver.

Specified by:

setParent in interface TypeSolver

tryToSolveType

public SymbolReference<ResolvedReferenceTypeDeclaration> tryToSolveType(String name)

Description copied from interface: TypeSolver

Try to solve the type with the given name. It always return a SymbolReference which can be solved or unsolved.

Specified by:

tryToSolveType in interface TypeSolver

solveType

public ResolvedReferenceTypeDeclaration solveType(String name)
                                           throws UnsolvedSymbolException

Description copied from interface: TypeSolver

Solve the given type. Either the type is found and returned or an UnsolvedSymbolException is thrown.

Specified by:

solveType in interface TypeSolver

Throws:

UnsolvedSymbolException