org.acm.seguin.summary
Class FieldAccessSummary

java.lang.Object
  extended by org.acm.seguin.summary.Summary
      extended by org.acm.seguin.summary.FieldAccessSummary
All Implemented Interfaces:
java.io.Serializable, net.sourceforge.jrefactory.ast.ModifierHolder

public class FieldAccessSummary
extends Summary

Summarize a field access summary.

Author:
Chris Seguin, Achille Petrilli, mods to distinguish read from write access
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.acm.seguin.summary.Summary
modifiers
 
Fields inherited from interface net.sourceforge.jrefactory.ast.ModifierHolder
ABSTRACT, EXPLICIT, FINAL, INTERFACE, names, NATIVE, PRIVATE, PROTECTED, PUBLIC, STATIC, STRICTFP, SYNCHRONIZED, TRANSIENT, VOLATILE
 
Constructor Summary
FieldAccessSummary(Summary parentSummary, net.sourceforge.jrefactory.ast.ASTName nameNode)
          Creates a field access summary from an ASTName object.
 
Method Summary
 java.lang.Object accept(SummaryVisitor visitor, java.lang.Object data)
          Provide method to visit a node
 boolean equals(java.lang.Object other)
          Check to see if it is equal
 java.lang.String getFieldName()
          Get the name of the field
 java.lang.String getFirstObject()
          Gets the FirstObject attribute of the FieldAccessSummary object
 java.lang.String getName()
          Gets the Name attribute of the FieldAccessSummary object
 java.lang.String getObjectName()
          Get the name of the type
 java.lang.String getPackageName()
          Get the package name
 TypeDeclSummary getTypeDecl()
          Gets a type declaration if this reference is to a package and type pair
 boolean isAssignment()
          Gets the Assignment attribute of the FieldAccessSummary object
 java.lang.String toString()
          Convert this into a string
 
Methods inherited from class org.acm.seguin.summary.Summary
addModifier, copyModifiers, getDeclarationLine, getEndLine, getModifiers, getModifiersString, getParent, getStartLine, isAbstract, isExplicit, isFinal, isInterface, isNative, isPackage, isPrivate, isProtected, isPublic, isStatic, isStrictFP, isSynchronized, isTransient, isVolatile, setAbstract, setAbstract, setCode, setEndLine, setFinal, setModifiers, setPrivate, setPrivate, setProtected, setProtected, setPublic, setPublic, setStartLine, setStatic, setStatic, setStrict, setSynchronized, setSynchronized, toStandardOrderString, toStringAlphabetical
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FieldAccessSummary

public FieldAccessSummary(Summary parentSummary,
                          net.sourceforge.jrefactory.ast.ASTName nameNode)
Creates a field access summary from an ASTName object.

Parameters:
parentSummary - the parent summary
nameNode - the ASTName object
Method Detail

isAssignment

public boolean isAssignment()
Gets the Assignment attribute of the FieldAccessSummary object

Returns:
The Assignment value

getPackageName

public java.lang.String getPackageName()
Get the package name

Returns:
a string containing the name of the package

getObjectName

public java.lang.String getObjectName()
Get the name of the type

Returns:
a string containing the name of the type

getFieldName

public java.lang.String getFieldName()
Get the name of the field

Returns:
a string containing the name of the field

getTypeDecl

public TypeDeclSummary getTypeDecl()
Gets a type declaration if this reference is to a package and type pair

Returns:
the summary

getFirstObject

public java.lang.String getFirstObject()
Gets the FirstObject attribute of the FieldAccessSummary object

Returns:
The FirstObject value

getName

public java.lang.String getName()
Gets the Name attribute of the FieldAccessSummary object

Specified by:
getName in class Summary
Returns:
The Name value

toString

public java.lang.String toString()
Convert this into a string

Overrides:
toString in class java.lang.Object
Returns:
a string representation of the type

accept

public java.lang.Object accept(SummaryVisitor visitor,
                               java.lang.Object data)
Provide method to visit a node

Overrides:
accept in class Summary
Parameters:
visitor - the visitor
data - the data for the visit
Returns:
some new data

equals

public boolean equals(java.lang.Object other)
Check to see if it is equal

Overrides:
equals in class java.lang.Object
Parameters:
other - the other item
Returns:
true if they are equal