Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> scopemvc >> [ core overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.scopemvc.core
Class Control  

java.lang.Object
  org.scopemvc.core.Control

---

public class Control

extends java.lang.Object

A token passed up the chain of Controllers to invoke a piece of presentation logic. Controllers match against the ID of a Control passed into handleControl 55 If the ID is recognised then the Controller can execute some presentation logic. If the Control ID is not recognised, the Control should be sent back on its journey up the chain of responsibility by passing it to the parent Controller. See org.scopemvc.controller.basic.BasicController#passControlToParent.

Controls are received by a Controller from either a View or a child Controller.

Controls can optionally contain an Object parameter: see getParameter() 55

The Control ID is used by Controllers to recognise a Control and also as a key to the user-readable version of the the Control's name in UIStrings presented to the user by the default error-handling mechanism in BasicController.

Version:

$Revision: 1.4 $ $Date: 2002/01/19 13:01:04 $

---

Field Summary
private  java.lang.String	id
private  boolean	matched
private  java.lang.Object	parameter

 

Constructor Summary

Control(java.lang.String inID)           Create a Control with a unique String ID and no parameter.

Control(java.lang.String inID, java.lang.Object inParameter)           Create a Control with a unique String ID and a parameter.

 

Method Summary
boolean	equals(java.lang.Object o)           Determine whether this Object is semantically equal to another Object.
java.lang.String	getName()           Deprecated. use matchesID(java.lang.String) 55 not this method which will be removed at some point.
java.lang.Object	getParameter()
int	hashCode()           Get a value that represents this Object, as uniquely as possible within the confines of an int.
boolean	isMatched()           Has this Control been matched by a Controller yet?
void	markMatched()
void	markUnmatched()
boolean	matchesID(java.lang.String inID)           Use this method in Controller's doHandleControl to discover Controls that you want to handle.
void	populateControlException(ControlException inException)           For use by a ControlException handler only, not for application writers.
void	setParameter(java.lang.Object inParameter)
java.lang.String	toString()           Convert this Object to a human-readable String.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

id

private java.lang.String id

---

parameter

private java.lang.Object parameter

---

matched

private boolean matched

Constructor Detail

Control

public Control(java.lang.String inID)

Create a Control with a unique String ID and no parameter.

---

Control

public Control(java.lang.String inID,
               java.lang.Object inParameter)

Create a Control with a unique String ID and a parameter.

Method Detail

getName

public final java.lang.String getName()

Deprecated. use matchesID(java.lang.String) 55 not this method which will be removed at some point.

For matching a Control in a Controller's doHandleControl, always use matchesID(java.lang.String) 55 not this method.

---

isMatched

public final boolean isMatched()

Has this Control been matched by a Controller yet?

---

markUnmatched

public final void markUnmatched()

---

markMatched

public final void markMatched()

---

matchesID

public final boolean matchesID(java.lang.String inID)

Use this method in Controller's doHandleControl to discover Controls that you want to handle.

---

setParameter

public final void setParameter(java.lang.Object inParameter)

---

getParameter

public final java.lang.Object getParameter()

---

populateControlException

public void populateControlException(ControlException inException)

For use by a ControlException handler only, not for application writers.

---

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)

---

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()).

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> scopemvc >> [ core overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---