ice.storm
Class Hint

java.lang.Object
  ice.storm.Hint

public class Hint

extends Object

Class containing details of an unusual situation.

Author:

EWK

Constructor Summary

Hint(Object theSource, ContentLoader cl)
For sources which don't have a ContentLoader available, use new Hint(this,null); Usually, a Hint object is created from a Pilot's parse method, where a ContentLoader is always available.

Method Summary

ContentLoader	getContentLoader() For the sources where a ContentLoader is available.
String	getContentType()
String	getCustomDescription() A short description of the anomaly, meant to be eligible to end users.
Exception	getException()
String	getLocation()
Object	getSource() The sender
URL	getUrl() Deprecated. Use getLocation().
void	setContentType(String value)
void	setCustomDescription(String value) Should be used by all sources, since this cannot be extracted from the ContentLoader.
void	setException(Exception value)
void	setLocation(String value)
void	setUrl(URL value) Deprecated. Use setLocation(String).

Methods inherited from class java.lang.Object

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

Constructor Detail

Hint

public Hint(Object theSource,
            ContentLoader cl)

For sources which don't have a ContentLoader available, use new Hint(this,null); Usually, a Hint object is created from a Pilot's parse method, where a ContentLoader is always available. The customDescription field should be completed, but the other fields are completed by the constructor.

Method Detail

getSource

public Object getSource()

The sender

getContentLoader

public ContentLoader getContentLoader()

For the sources where a ContentLoader is available. If there is not, one should try to complete the below fields. If a ContentLoader is passed to the constructor, location, url and contentType will be completed automatically.

getLocation

public String getLocation()

setLocation

public void setLocation(String value)

getException

public Exception getException()

setException

public void setException(Exception value)

getCustomDescription

public String getCustomDescription()

A short description of the anomaly, meant to be eligible to end users.

setCustomDescription

public void setCustomDescription(String value)

Should be used by all sources, since this cannot be extracted from the ContentLoader.

getUrl

public URL getUrl()

Deprecated. Use getLocation().

setUrl

public void setUrl(URL value)

Deprecated. Use setLocation(String).

getContentType

public String getContentType()

setContentType

public void setContentType(String value)