CommandWord

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> eireneh >> bible >> control >> search >> [ words overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.eireneh.bible.control.search.words.CommandWord

SOURCE |

Download com.eireneh.bible.control.search.words.CommandWord

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.eireneh.bible.control.search.words
Interface CommandWord

All Superinterfaces:: SearchWord

All Known Implementing Classes:: AddCommandWord, BlurCommandWord, RemoveCommandWord, RetainCommandWord

public interface CommandWord
extends SearchWord

CommandWord extends SearchWord to allow actions that alter a base Passage. Implementations of this interface may use the Engine to get at a default Bible (or they may have one hard coded if necessary) or to get at ParamWords that follow this command.

Distribution Licence:
Project B is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2 as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
The License is available on the internet here, by writing to Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA, Or locally at the Licence link below.
The copyright to this program is held by it's authors.

Method Summary

void updatePassage(com.eireneh.bible.control.search.Engine engine, com.eireneh.bible.passage.Passage ref)
Alter a Passage in whatever manner is appropriate for this command.

Method Detail

updatePassage

public void updatePassage(com.eireneh.bible.control.search.Engine engine,
                          com.eireneh.bible.passage.Passage ref)
                   throws com.eireneh.bible.control.search.SearchException

Alter a Passage in whatever manner is appropriate for this command. for example the "~" command does something like this: ref.blur(engine.elements.next.getWord); The "&" command looks like this: ref.addAll(engine.elements.next.getPassage);