Package sootup.java.core

Class JavaSootClass

java.lang.Object

sootup.core.model.AbstractClass

sootup.core.model.SootClass

sootup.java.core.JavaSootClass

All Implemented Interfaces:

HasPosition, HasAnnotation

Direct Known Subclasses:

JavaAnnotationSootClass

public class JavaSootClass
extends SootClass
implements HasAnnotation

Nested Class Summary

Nested classes/interfaces inherited from class sootup.core.model.SootClass

SootClass.SootClassBuilder

Field Summary

Fields inherited from class sootup.core.model.SootClass

classSignature, sourceType

Fields inherited from class sootup.core.model.AbstractClass

classSource

Constructor Summary

Constructors

Constructor	Description
JavaSootClass(JavaSootClassSource classSource, SourceType sourceType)

Method Summary

Modifier and Type	Method	Description
@NonNull Iterable<AnnotationUsage>	getAnnotations()	Get all annotations that are directly attached to this class.
@NonNull JavaSootClassSource	getClassSource()
@NonNull Optional<JavaSootField>	getField(@NonNull String name)	Returns the field of this class with the given name.
@NonNull Optional<JavaSootField>	getField(@NonNull FieldSubSignature subSignature)	Attemtps to retrieve the field with the given FieldSubSignature.
@NonNull Set<JavaSootField>	getFields()	Gets the fields of this SootClass in an immutable set.
@NonNull Optional<JavaSootMethod>	getMethod(@NonNull String name, @NonNull Iterable<? extends Type> parameterTypes)	Attempts to retrieve the method with the given name and parameters.
@NonNull Optional<JavaSootMethod>	getMethod(@NonNull MethodSubSignature subSignature)	Attempts to retrieve the method with the given subSignature.
@NonNull Set<JavaSootMethod>	getMethods()	Gets the methods of this SootClass in an immutable set.
@NonNull Set<JavaSootMethod>	getMethodsByName(@NonNull String name)	Attempts to retrieve the method with the given name.
@NonNull Optional<JavaClassType>	getOuterClass()	This method returns the outer class.
@NonNull Optional<JavaClassType>	getSuperclass()	WARNING: interfaces in Java are subclasses of the java.lang.Object class!
@NonNull JavaClassType	getType()	Returns the ClassSignature of this class.
@NonNull JavaSootClass	withFields(@NonNull Collection<JavaSootField> fields)
@NonNull JavaSootClass	withMethods(@NonNull Collection<JavaSootMethod> methods)
@NonNull JavaSootClass	withModifiers(@NonNull Set<ClassModifier> modifiers)
@NonNull JavaSootClass	withOuterClass(@NonNull Optional<JavaClassType> outerClass)
@NonNull JavaSootClass	withOverridingClassSource(Function<OverridingJavaClassSource,OverridingJavaClassSource> overrider)	Creates a new JavaSootClass based on a new OverridingJavaClassSource.
@NonNull JavaSootClass	withPosition(@Nullable Position position)
@NonNull JavaSootClass	withReplacedField(@NonNull JavaSootField toReplace, @NonNull JavaSootField replacement)
@NonNull JavaSootClass	withReplacedMethod(@NonNull JavaSootMethod toReplace, @NonNull JavaSootMethod replacement)
@NonNull JavaSootClass	withSuperclass(@NonNull Optional<JavaClassType> superclass)

Methods inherited from class sootup.core.model.SootClass

getInterfaces, getModifiers, getName, getPosition, hasOuterClass, hasSuperclass, implementsInterface, isAbstract, isAnnotation, isApplicationClass, isConcrete, isEnum, isFinal, isInnerClass, isInterface, isLibraryClass, isPrivate, isProtected, isPublic, isStatic, isSuper, print, toString, withClassSource, withSourceType

Methods inherited from class java.lang.Object

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

Constructor Details

JavaSootClass

public JavaSootClass(JavaSootClassSource classSource,
 SourceType sourceType)

Method Details

getType

public @NonNull JavaClassType getType()

Description copied from class: SootClass

Returns the ClassSignature of this class.

Overrides:

getType in class SootClass

getAnnotations

public @NonNull Iterable<AnnotationUsage> getAnnotations()

Get all annotations that are directly attached to this class.

This includes "visible" and "invisible" annotations. Note that inherited annotations are not part of this iterable.

Specified by:

getAnnotations in interface HasAnnotation

Returns:

getMethods

public @NonNull Set<JavaSootMethod> getMethods()

Description copied from class: SootClass

Gets the methods of this SootClass in an immutable set.

Overrides:

getMethods in class SootClass

getFields

public @NonNull Set<JavaSootField> getFields()

Description copied from class: SootClass

Gets the fields of this SootClass in an immutable set.

Overrides:

getFields in class SootClass

getField

public @NonNull Optional<JavaSootField> getField(@NonNull String name)

Description copied from class: AbstractClass

Returns the field of this class with the given name. Throws a ResolveException if there is more than one field with the given name. Returns null if no field with the given name exists.

Overrides:

getField in class AbstractClass

getField

public @NonNull Optional<JavaSootField> getField(@NonNull FieldSubSignature subSignature)

Description copied from class: AbstractClass

Attemtps to retrieve the field with the given FieldSubSignature.

Overrides:

getField in class AbstractClass

getMethod

public @NonNull Optional<JavaSootMethod> getMethod(@NonNull String name,
 @NonNull Iterable<? extends Type> parameterTypes)

Description copied from class: AbstractClass

Attempts to retrieve the method with the given name and parameters. This method may throw an ResolveException if there is more than one method with the given name and parameter.

Overrides:

getMethod in class AbstractClass

getMethodsByName

public @NonNull Set<JavaSootMethod> getMethodsByName(@NonNull String name)

Description copied from class: AbstractClass

Attempts to retrieve the method with the given name. This method will return an empty Set if there is no method with the given name.

Overrides:

getMethodsByName in class AbstractClass

Parameters:

name - the name of the method

Returns:

a set of methods that have the given name

getMethod

public @NonNull Optional<JavaSootMethod> getMethod(@NonNull MethodSubSignature subSignature)

Description copied from class: AbstractClass

Attempts to retrieve the method with the given subSignature. This method may throw an AmbiguousStateException if there are more than one method with the given subSignature. If no method with the given is found, null is returned.

Overrides:

getMethod in class AbstractClass

getClassSource

public @NonNull JavaSootClassSource getClassSource()

Overrides:

getClassSource in class SootClass

getOuterClass

public @NonNull Optional<JavaClassType> getOuterClass()

Description copied from class: SootClass

This method returns the outer class.

Overrides:

getOuterClass in class SootClass

getSuperclass

public @NonNull Optional<JavaClassType> getSuperclass()

Description copied from class: SootClass

WARNING: interfaces in Java are subclasses of the java.lang.Object class! Returns the superclass of this class. (see hasSuperclass())

Overrides:

getSuperclass in class SootClass

withOverridingClassSource

public @NonNull JavaSootClass withOverridingClassSource(Function<OverridingJavaClassSource,OverridingJavaClassSource> overrider)

Creates a new JavaSootClass based on a new OverridingJavaClassSource. This is useful to change selected parts of a SootClass without recreating a JavaSootClassSource completely. OverridingJavaClassSource allows for replacing specific parts of a class, such as fields and methods.

withReplacedMethod

public @NonNull JavaSootClass withReplacedMethod(@NonNull JavaSootMethod toReplace,
 @NonNull JavaSootMethod replacement)

withMethods

public @NonNull JavaSootClass withMethods(@NonNull Collection<JavaSootMethod> methods)

withReplacedField

public @NonNull JavaSootClass withReplacedField(@NonNull JavaSootField toReplace,
 @NonNull JavaSootField replacement)

withFields

public @NonNull JavaSootClass withFields(@NonNull Collection<JavaSootField> fields)

withModifiers

public @NonNull JavaSootClass withModifiers(@NonNull Set<ClassModifier> modifiers)

withSuperclass

public @NonNull JavaSootClass withSuperclass(@NonNull Optional<JavaClassType> superclass)

withOuterClass

public @NonNull JavaSootClass withOuterClass(@NonNull Optional<JavaClassType> outerClass)

withPosition

public @NonNull JavaSootClass withPosition(@Nullable Position position)