com.oziexplorer
Class Event

java.lang.Object
  com.oziexplorer.Event

public class Event
extends Object

This class represents events.

Copyright 2011 Alan Burlison, . All rights reserved. Use is subject to license terms, see LICENSE.txt.

Field Summary

protected int	backColor The symbol background color.
protected int	foreColor The symbol foreground color.
protected int	mapDisplayFormat The map display format.
protected int	number The event number.
protected Position	position The position.
protected int	symbol The symbol.
protected int	symbolSize The symbol size.

Constructor Summary

Event(int number, Position position, int symbol, int mapDisplayFormat, int foreColor, int backColor, int symbolSize)
Create a new Event.

Method Summary

boolean	equals(Object that) Test if two events are equal.
int	getBackColor() Get the background color.
int	getForeColor() Get the foreground color,
int	getMapDisplayFormat() get the nap display format.
int	getNumber() Get the event number.
Position	getPosition() Get the event position.
int	getSymbol() Get the event symbol.
int	getSymbolSize() Get the symbol size.
int	hashCode() Return the hash code for this object.

Methods inherited from class java.lang.Object

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

Field Detail

number

protected final int number

The event number.

position

protected final Position position

The position.

symbol

protected final int symbol

The symbol.

mapDisplayFormat

protected final int mapDisplayFormat

The map display format.

foreColor

protected final int foreColor

The symbol foreground color.

backColor

protected final int backColor

The symbol background color.

symbolSize

protected final int symbolSize

The symbol size.

Constructor Detail

Event

public Event(int number,
             Position position,
             int symbol,
             int mapDisplayFormat,
             int foreColor,
             int backColor,
             int symbolSize)

Create a new Event.

Parameters:

number - the event number.

position - the event position

symbol - the event symbol.

mapDisplayFormat - the map display format.

foreColor - the foreground colour.

backColor - the background colour.

symbolSize - the symbol size.

Method Detail

equals

public boolean equals(Object that)

Test if two events are equal. The position and symbol are compared.

Overrides:

equals in class Object

Parameters:

that - the object to compare against.

Returns:

true if the objects are equal.

hashCode

public int hashCode()

Return the hash code for this object.

Overrides:

hashCode in class Object

Returns:

the hash code for this object.

getBackColor

public int getBackColor()

Get the background color.

Returns:

tge background color.

getForeColor

public int getForeColor()

Get the foreground color,

Returns:

the foreground color.

getMapDisplayFormat

public int getMapDisplayFormat()

get the nap display format.

Returns:

the map display format.

getNumber

public int getNumber()

Get the event number.

Returns:

the event number.

getPosition

public Position getPosition()

Get the event position.

Returns:

the event position.

getSymbol

public int getSymbol()

Get the event symbol.

Returns:

the event symbol.

getSymbolSize

public int getSymbolSize()

Get the symbol size.

Returns:

the symbol size.