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

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

@Nonnull
public JavaClassType getType()

Description copied from class: SootClass

Returns the ClassSignature of this class.

Overrides:

getType in class SootClass

getAnnotations

@Nonnull
public 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

@Nonnull
public Set<JavaSootMethod> getMethods()

Description copied from class: SootClass

Gets the methods of this SootClass in an immutable set.

Overrides:

getMethods in class SootClass

getFields

@Nonnull
public Set<JavaSootField> getFields()

Description copied from class: SootClass

Gets the fields of this SootClass in an immutable set.

Overrides:

getFields in class SootClass

getField

@Nonnull
public 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

@Nonnull
public 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

@Nonnull
public 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

@Nonnull
public 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

@Nonnull
public 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

@Nonnull
public JavaSootClassSource getClassSource()

Overrides:

getClassSource in class SootClass

getOuterClass

@Nonnull
public Optional<JavaClassType> getOuterClass()

Description copied from class: SootClass

This method returns the outer class.

Overrides:

getOuterClass in class SootClass

getSuperclass

@Nonnull
public 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

@Nonnull
public 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

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

withMethods

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

withReplacedField

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

withFields

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

withModifiers

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

withSuperclass

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

withOuterClass

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

withPosition

@Nonnull
public JavaSootClass withPosition(@Nullable
 Position position)