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 ExternalConstructor  

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

All Implemented Interfaces:

IDefinition, IMethod, Typed

---

public class ExternalConstructor

extends ExternalDefinition

implements IMethod

---

Field Summary
private  java.lang.reflect.Constructor	_javaConstructor
private  ISignature	_signature

 

Constructor Summary

ExternalConstructor(java.lang.reflect.Constructor javaConstructor)

 

Method Summary
boolean	equals(java.lang.Object o)           Determine whether this Object is semantically equal to another Object.
IClass[]	getExceptions()
java.lang.reflect.Constructor	getJavaConstructor()
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.
ISignature	getSignature()           Returns the signature of this method.
IClass	getType()           gets the type of this definition
boolean	hasCompatibleSignature(ISignature signature)           verifies if the input signature type is compatible with this method signature
int	hashCode()           Get a value that represents this Object, as uniquely as possible within the confines of an int.
boolean	hasSameSignature(ISignature signature)           verifies if the input signature is the same with signatures of this method
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

_javaConstructor

private java.lang.reflect.Constructor _javaConstructor

---

_signature

private ISignature _signature

Constructor Detail

ExternalConstructor

public ExternalConstructor(java.lang.reflect.Constructor javaConstructor)

Method Detail

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

---

getType

public IClass getType()

Description copied from interface: Typed

gets the type of this definition

Specified by:

getType in interface Typed

---

getSignature

public ISignature getSignature()

Description copied from interface: IMethod

Returns the signature of this method.

Specified by:

getSignature in interface IMethod

---

hasSameSignature

public boolean hasSameSignature(ISignature signature)

Description copied from interface: IMethod

verifies if the input signature is the same with signatures of this method

Specified by:

hasSameSignature in interface IMethod

---

hasCompatibleSignature

public boolean hasCompatibleSignature(ISignature signature)

Description copied from interface: IMethod

verifies if the input signature type is compatible with this method signature

Specified by:

hasCompatibleSignature in interface IMethod

---

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

---

getJavaConstructor

public java.lang.reflect.Constructor getJavaConstructor()

---

getExceptions

public IClass[] getExceptions()

Specified by:

getExceptions in interface IMethod

---

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

---