Package it.unive.lisa.program

Class InterfaceUnit

java.lang.Object

it.unive.lisa.program.Unit

it.unive.lisa.program.ProgramUnit

it.unive.lisa.program.CompilationUnit

it.unive.lisa.program.InterfaceUnit

All Implemented Interfaces:

CodeElement

public class InterfaceUnit
extends CompilationUnit

A interface unit of the program to analyze. A interface unit is a Unit that only defines instance members, from which other units (both ClassUnit and InterfaceUnit) can inherit from

Field Summary

Fields inherited from class it.unive.lisa.program.CompilationUnit

instances

Constructor Summary

Constructors

Constructor	Description
InterfaceUnit(CodeLocation location, Program program, java.lang.String name, boolean sealed)	Builds an interface unit, defined at the given location.

Method Summary

Modifier and Type	Method	Description
boolean	addAncestor(CompilationUnit unit)	Adds a new CompilationUnit as direct inheritance ancestor (i.e., superclass, interface, or superinterface) of this unit.
void	addInstance(Unit unit)	Adds the given unit as an instance of this one, thus marking the former as a type that inherits from the latter.
boolean	addSuperinterface(InterfaceUnit unit)	Adds the given InterfaceUnit to the list of direct ancestors of this interface.
boolean	canBeInstantiated()	Yields true if this unit can be instantiated, false otherwise (e.g., interfaces, abstract classes).
java.util.Collection<CompilationUnit>	getImmediateAncestors()	Yields the collection of CompilationUnits that are this unit directly inherits from, regardless of their type.
boolean	isInstanceOf(CompilationUnit unit)	Yields true if and only if this unit is an instance of the given one.

Methods inherited from class it.unive.lisa.program.CompilationUnit

addAnnotation, addInstanceCodeMember, addInstanceGlobal, getAbstractCodeMembers, getAnnotations, getCodeMembersRecursively, getGlobalsRecursively, getInstanceCFGs, getInstanceCodeMember, getInstanceCodeMembers, getInstanceCodeMembersByName, getInstanceConstructs, getInstanceGlobal, getInstanceGlobals, getInstances, getMatchingInstanceCodeMembers, isSealed, searchCodeMembers, searchGlobals

Methods inherited from class it.unive.lisa.program.ProgramUnit

getLocation, getProgram

Methods inherited from class it.unive.lisa.program.Unit

addCodeMember, addGlobal, getCodeMember, getCodeMembers, getCodeMembersByName, getGlobal, getGlobals, getMatchingCodeMember, getName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

InterfaceUnit

public InterfaceUnit(CodeLocation location,
                     Program program,
                     java.lang.String name,
                     boolean sealed)

Builds an interface unit, defined at the given location.

Parameters:

location - the location where the unit is define within the source file

program - the program where this unit is defined

name - the name of the unit

sealed - whether or not this unit can be inherited from

Method Detail

canBeInstantiated

public boolean canBeInstantiated()

Description copied from class: Unit

Yields true if this unit can be instantiated, false otherwise (e.g., interfaces, abstract classes).

Specified by:

canBeInstantiated in class Unit

Returns:

true if this unit can be instantiated, false otherwise

addSuperinterface

public boolean addSuperinterface(InterfaceUnit unit)

Adds the given InterfaceUnit to the list of direct ancestors of this interface.

Parameters:

unit - the unit to add

Returns:

true only if the list has changed

getImmediateAncestors

public java.util.Collection<CompilationUnit> getImmediateAncestors()

Description copied from class: CompilationUnit

Yields the collection of CompilationUnits that are this unit directly inherits from, regardless of their type.

Specified by:

getImmediateAncestors in class CompilationUnit

Returns:

the collection of units that are direct ancestors of this one

addInstance

public void addInstance(Unit unit)
                 throws ProgramValidationException

Description copied from class: CompilationUnit

Adds the given unit as an instance of this one, thus marking the former as a type that inherits from the latter.

Specified by:

addInstance in class CompilationUnit

Parameters:

unit - the unit to be added

Throws:

ProgramValidationException - if the given unit cannot be added

isInstanceOf

public boolean isInstanceOf(CompilationUnit unit)

Description copied from class: CompilationUnit

Yields true if and only if this unit is an instance of the given one. This method works correctly even if ProgramValidationLogic.validateAndFinalize(Program) has not been invoked yet, and thus the if collection of instances of the given unit is not yet available.

Specified by:

isInstanceOf in class CompilationUnit

Parameters:

unit - the other unit

Returns:

true only if that condition holds

addAncestor

public boolean addAncestor(CompilationUnit unit)

Description copied from class: CompilationUnit

Adds a new CompilationUnit as direct inheritance ancestor (i.e., superclass, interface, or superinterface) of this unit.

Specified by:

addAncestor in class CompilationUnit

Parameters:

unit - the unit to add

Returns:

true if the collection of ancestors changed as a result of the call