Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> puppycrawl >> tools >> checkstyle >> checks >> usage >> [ transmogrify overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.puppycrawl.tools.checkstyle.checks.usage.transmogrify
Class ExternalClass  

java.lang.Object
  com.puppycrawl.tools.checkstyle.checks.usage.transmogrify.ExternalDefinition
      com.puppycrawl.tools.checkstyle.checks.usage.transmogrify.ExternalClass

All Implemented Interfaces:

IClass, IDefinition

---

public class ExternalClass

extends ExternalDefinition

implements IClass

---

Field Summary
private  java.util.List	_implementors
private  java.lang.Class	_javaClass
private  java.util.Set	_methods
private  java.util.List	_subclasses

 

Constructor Summary

ExternalClass(java.lang.Class javaClass)

 

Method Summary
void	addImplementor(ClassDef implementor)           adds ClassDef to the collection of implemented interfaces of this class
void	addSubclass(ClassDef subclass)           adds ClassDef to the collection of (direct?) subclasses of this class
boolean	equals(java.lang.Object o)           Determine whether this Object is semantically equal to another Object.
private  IMethod	getClassConstructor(ISignature signature)
IClass	getClassDefinition(java.lang.String name)           gets class definition referenced by this class, including its inner classes, imported classes, packages, and its parent scope referenced class definitions
IMethod	getConstructorDefinition(ISignature signature)
java.util.List	getImplementors()           gets the list of ClassDefs that implmement this interface
IClass[]	getInnerClasses()           gets inner classes definition associated with this class
private  IMethod	getInterfaceConstructor(ISignature signature)
IClass[]	getInterfaces()           gets interfaces definition implemented by this class definition
java.lang.Class	getJavaClass()
private  java.lang.String	getLocalName()
IMethod	getMethodDefinition(java.lang.String name, ISignature signature)           gets the method associated with the given name and signature
private  java.util.Collection	getMethods()
IMethod	getMostCompatibleMethod(java.lang.String name, ISignature signature)
java.lang.String	getName()           gets the name that identified this particular definition/node
java.lang.String	getQualifiedName()           gets the fully qualified name of the definition, ie.
java.util.List	getSubclasses()           gets subclasses definition of this class definition
IClass	getSuperclass()           gets superclass definition of this class
IVariable	getVariableDefinition(java.lang.String name)           gets the VariableDef associated with the given name
int	hashCode()           Get a value that represents this Object, as uniquely as possible within the confines of an int.
boolean	isCompatibleWith(IClass type)           verifies if the input type is equal to this class or its superclass or its interfaces
boolean	isPrimitive()           verifies if this class is of primitive Java type
private  boolean	isPrimitiveCompatibleWith(IClass type)
java.lang.String	toString()           Convert this Object to a human-readable String.

 

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.usage.transmogrify.ExternalDefinition

addReference, getNumReferences, getReferences, isSourced

 

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

 

Methods inherited from interface com.puppycrawl.tools.checkstyle.checks.usage.transmogrify.IDefinition

addReference, getNumReferences, getReferences, isSourced

 

Field Detail

_javaClass

private java.lang.Class _javaClass

---

_subclasses

private java.util.List _subclasses

---

_implementors

private java.util.List _implementors

---

_methods

private java.util.Set _methods

Constructor Detail

ExternalClass

public ExternalClass(java.lang.Class javaClass)

Method Detail

getJavaClass

public java.lang.Class getJavaClass()

---

getName

public java.lang.String getName()

Description copied from interface: IDefinition

gets the name that identified this particular definition/node

Specified by:

getName in interface IDefinition

---

getLocalName

private java.lang.String getLocalName()

---

getSuperclass

public IClass getSuperclass()

Description copied from interface: IClass

gets superclass definition of this class

Specified by:

getSuperclass in interface IClass

---

getInterfaces

public IClass[] getInterfaces()

Description copied from interface: IClass

gets interfaces definition implemented by this class definition

Specified by:

getInterfaces in interface IClass

---

getClassDefinition

public IClass getClassDefinition(java.lang.String name)

Description copied from interface: IClass

gets class definition referenced by this class, including its inner classes, imported classes, packages, and its parent scope referenced class definitions

Specified by:

getClassDefinition in interface IClass

---

getVariableDefinition

public IVariable getVariableDefinition(java.lang.String name)

Description copied from interface: IClass

gets the VariableDef associated with the given name

Specified by:

getVariableDefinition in interface IClass

---

getMethodDefinition

public IMethod getMethodDefinition(java.lang.String name,
                                   ISignature signature)

Description copied from interface: IClass

gets the method associated with the given name and signature

Specified by:

getMethodDefinition in interface IClass

---

getMostCompatibleMethod

public IMethod getMostCompatibleMethod(java.lang.String name,
                                       ISignature signature)

---

getMethods

private java.util.Collection getMethods()

---

getConstructorDefinition

public IMethod getConstructorDefinition(ISignature signature)

---

getInterfaceConstructor

private IMethod getInterfaceConstructor(ISignature signature)

---

getClassConstructor

private IMethod getClassConstructor(ISignature signature)

---

isCompatibleWith

public boolean isCompatibleWith(IClass type)

Description copied from interface: IClass

verifies if the input type is equal to this class or its superclass or its interfaces

Specified by:

isCompatibleWith in interface IClass

---

isPrimitiveCompatibleWith

private boolean isPrimitiveCompatibleWith(IClass type)

---

addImplementor

public void addImplementor(ClassDef implementor)

Description copied from interface: IClass

adds ClassDef to the collection of implemented interfaces of this class

Specified by:

addImplementor in interface IClass

---

getImplementors

public java.util.List getImplementors()

Description copied from interface: IClass

gets the list of ClassDefs that implmement this interface

Specified by:

getImplementors in interface IClass

---

addSubclass

public void addSubclass(ClassDef subclass)

Description copied from interface: IClass

adds ClassDef to the collection of (direct?) subclasses of this class

Specified by:

addSubclass in interface IClass

---

getSubclasses

public java.util.List getSubclasses()

Description copied from interface: IClass

gets subclasses definition of this class definition

Specified by:

getSubclasses in interface IClass

---

getQualifiedName

public java.lang.String getQualifiedName()

Description copied from interface: IDefinition

gets the fully qualified name of the definition, ie. dotted name for classes, or method name with its signature for methods, etc

Specified by:

getQualifiedName in interface IDefinition

---

isPrimitive

public boolean isPrimitive()

Description copied from interface: IClass

verifies if this class is of primitive Java type

Specified by:

isPrimitive in interface IClass

---

getInnerClasses

public IClass[] getInnerClasses()

Description copied from interface: IClass

gets inner classes definition associated with this class

Specified by:

getInnerClasses in interface IClass

---

toString

public java.lang.String toString()

Description copied from class: java.lang.Object

Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

---

equals

public boolean equals(java.lang.Object o)

Description copied from class: java.lang.Object

Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

• It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
• It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
• It must be reflexive. a.equals(a) must always be true.
• It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
• a.equals(null) must be false.
• It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

---

hashCode

public int hashCode()

Description copied from class: java.lang.Object

Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

• Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
• It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> puppycrawl >> tools >> checkstyle >> checks >> usage >> [ transmogrify overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---