Class Command

java.lang.Object

Command

public class Command
extends java.lang.Object

This class is part of the "Pere-noel" application. "Pere Noel" is a very simple, text based adventure game. This class holds information about a command that was issued by the user. A command currently consists of two strings: a command word and a second word (for example, if the command was "take map", then the two strings obviously are "take" and "map"). The way this is used is: Commands are already checked for being valid command words. If the user entered an invalid command (a word that is not known) then the command word is . If the command had only one word, then the second word is .

Author:

Célia PRIOL & Benoît CHAUVEAU

Constructor Summary

Constructors

Constructor and Description
Command(CommandWord firstWord, java.lang.String secondWord) Create a command object.

Method Summary

Methods

Modifier and Type	Method and Description
CommandWord	getCommandWord() Return the command word (the first word) of this command.
java.lang.String	getSecondWord() See "Returns" comment.
boolean	hasSecondWord() See "Returns" comment.
boolean	isUnknown() See "Returns" comment.

Methods inherited from class java.lang.Object

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

Constructor Detail

Command

public Command(CommandWord firstWord,
       java.lang.String secondWord)

Create a command object. First and second word must be supplied, but either one (or both) can be null.

Parameters:

firstWord - The first word of the command. Null if the command was not recognised.

secondWord - The second word of the command.

Method Detail

getCommandWord

public CommandWord getCommandWord()

Return the command word (the first word) of this command. If the command was not understood, the result is null.

Returns:

The command word.

getSecondWord

public java.lang.String getSecondWord()

See "Returns" comment.

Returns:

The second word of this command. Returns null if there was no second word.

isUnknown

public boolean isUnknown()

See "Returns" comment.

Returns:

true if this command was not understood.

hasSecondWord

public boolean hasSecondWord()

See "Returns" comment.

Returns:

true if the command has a second word.