Package sootup.java.core.views

Class JavaView

java.lang.Object

sootup.core.views.AbstractView

sootup.java.core.views.JavaView

All Implemented Interfaces:

View

Direct Known Subclasses:

JavaModuleView, MutableJavaView

public class JavaView
extends AbstractView

The Class JavaView manages the Java classes of the application being analyzed. This view cannot be altered after its creation.

Author:

Linghui Luo created on 31.07.2018, Jan Martin Persch

Field Summary

Fields

Modifier and Type	Field	Description
protected final ClassCache	cache
protected final JavaIdentifierFactory	identifierFactory
protected final List<AnalysisInputLocation>	inputLocations
protected boolean	isFullyResolved

Constructor Summary

Constructors

Modifier	Constructor	Description
	JavaView(List<AnalysisInputLocation> inputLocations)
	JavaView(List<AnalysisInputLocation> inputLocations, ClassCacheProvider cacheProvider)
protected	JavaView(List<AnalysisInputLocation> inputLocations, ClassCacheProvider cacheProvider, JavaIdentifierFactory idf)
	JavaView(AnalysisInputLocation inputLocation)

Method Summary

Modifier and Type	Method	Description
protected Optional<JavaSootClass>	buildClassFrom(AbstractClassSource classSource)
Optional<JavaAnnotationSootClass>	getAnnotationClass(ClassType type)
int	getCachedClassesCount()	Returns the number of classes that are currently stored in the cache.
Optional<JavaSootClass>	getClass(ClassType type)	Resolves the class matching the provided ClassType.
Stream<JavaSootClass>	getClasses()	Resolves all classes that are part of the view and stores them in the cache.
protected Optional<JavaSootClassSource>	getClassSource(ClassType type)
Optional<JavaSootField>	getField(FieldSignature signature)
JavaIdentifierFactory	getIdentifierFactory()	Returns the IdentifierFactory for this view.
Optional<JavaSootMethod>	getMethod(MethodSignature signature)	resolve and check for accessibility of the class from a given package * TODO: incorporate AccessUtil @Nonnull public synchronized Optional<T> getClass( @Nonnull PackageName entryPackage, @Nonnull ClassType type) { Optional<T> aClass = getClass(type); if (aClass.isPresent() && AccessUtil.isAccessible(entryPackage, aClass.get()) ) { return Optional.empty(); } return aClass; }

Methods inherited from class sootup.core.views.AbstractView

getTypeHierarchy

Methods inherited from class java.lang.Object

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

Methods inherited from interface sootup.core.views.View

getClassOrThrow

Field Details

identifierFactory

@Nonnull
protected final JavaIdentifierFactory identifierFactory

inputLocations

@Nonnull
protected final List<AnalysisInputLocation> inputLocations

cache

@Nonnull
protected final ClassCache cache

isFullyResolved

protected volatile boolean isFullyResolved

Constructor Details

JavaView

public JavaView(@Nonnull
 AnalysisInputLocation inputLocation)

JavaView

public JavaView(@Nonnull
 List<AnalysisInputLocation> inputLocations)

JavaView

public JavaView(@Nonnull
 List<AnalysisInputLocation> inputLocations,
 @Nonnull
 ClassCacheProvider cacheProvider)

JavaView

protected JavaView(@Nonnull
 List<AnalysisInputLocation> inputLocations,
 @Nonnull
 ClassCacheProvider cacheProvider,
 @Nonnull
 JavaIdentifierFactory idf)

Method Details

getClasses

@Nonnull
public Stream<JavaSootClass> getClasses()

Resolves all classes that are part of the view and stores them in the cache.

getClass

@Nonnull
public Optional<JavaSootClass> getClass(@Nonnull
 ClassType type)

Resolves the class matching the provided ClassType.

Returns:

A class with given signature.

getAnnotationClass

@Nonnull
public Optional<JavaAnnotationSootClass> getAnnotationClass(@Nonnull
 ClassType type)

getMethod

@Nonnull
public Optional<JavaSootMethod> getMethod(@Nonnull
 MethodSignature signature)

Description copied from class: AbstractView

resolve and check for accessibility of the class from a given package * TODO: incorporate AccessUtil @Nonnull public synchronized Optional<T> getClass( @Nonnull PackageName entryPackage, @Nonnull ClassType type) { Optional<T> aClass = getClass(type); if (aClass.isPresent() && AccessUtil.isAccessible(entryPackage, aClass.get()) ) { return Optional.empty(); } return aClass; }

Specified by:

getMethod in interface View

Overrides:

getMethod in class AbstractView

getField

@Nonnull
public Optional<JavaSootField> getField(@Nonnull
 FieldSignature signature)

Specified by:

getField in interface View

Overrides:

getField in class AbstractView

getIdentifierFactory

@Nonnull
public JavaIdentifierFactory getIdentifierFactory()

Description copied from interface: View

Returns the IdentifierFactory for this view.

getCachedClassesCount

public int getCachedClassesCount()

Returns the number of classes that are currently stored in the cache.

getClassSource

@Nonnull
protected Optional<JavaSootClassSource> getClassSource(@Nonnull
 ClassType type)

buildClassFrom

@Nonnull
protected Optional<JavaSootClass> buildClassFrom(AbstractClassSource classSource)