puzzled.grid
Class Clue

java.lang.Object
  |
  +--puzzled.grid.Clue

All Implemented Interfaces:

java.io.Serializable

public class Clue

extends java.lang.Object

implements java.io.Serializable

This class simply acts as a data structure to represent the clues entered by the user. They contain the clue text, the number of times they produced new information, and their specialClue status, which is used for clues have a OR relationship in their text or having a MORE/LESS relationships.

Version:

1.0 26 Aug 2001

Author:

Frédéric Demers

See Also:

Serialized Form

Constructor Summary

Clue(java.lang.String clueText_arg, int usage_arg, boolean specialClue_arg)
Constructor, takes in the parameter required for a relationship,

Method Summary

java.lang.String	getClueText()
int	getUsage()
void	incUsage()
boolean	isSpecial()
void	setSpecial(boolean newValue)
java.lang.String	toString() Method used when displaying the textual value of the clue

Methods inherited from class java.lang.Object

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

Constructor Detail

Clue

public Clue(java.lang.String clueText_arg,
            int usage_arg,
            boolean specialClue_arg)

Constructor, takes in the parameter required for a relationship,

Parameters:

clueText - the text string of the clue as entered in Puzzled

usage - the number of times this clue provided new information

specialClue - attribute given to clues needing periodical re-evaluation

Method Detail

toString

public java.lang.String toString()

Method used when displaying the textual value of the clue

Overrides:

toString in class java.lang.Object

getClueText

public java.lang.String getClueText()

getUsage

public int getUsage()

incUsage

public void incUsage()

setSpecial

public void setSpecial(boolean newValue)

isSpecial

public boolean isSpecial()