hmi.tts
Class Bookmark

java.lang.Object
  extended by hmi.tts.Bookmark
All Implemented Interfaces:
Comparable<Bookmark>

@Immutable
public final class Bookmark
extends Object
implements Comparable<Bookmark>

Bookmark in speech text. Contains a word description of the word after the bookmark and an offset in ms of the bookmark time relative to the start of the speech text. word is null if the bookmark is at the end of the sentence

Author:
welberge

Field Summary
private  String name
           
private  int offset
           
private  WordDescription word
           
 
Constructor Summary
Bookmark(String n, WordDescription w, int o)
           
 
Method Summary
 int compareTo(Bookmark o)
           
 boolean equals(Object o)
           
 String getName()
           
 int getOffset()
           
 WordDescription getWord()
          Word description of the word after this bookmark, null for none.
 int hashCode()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

name

private final String name

word

private final WordDescription word

offset

private final int offset
Constructor Detail

Bookmark

public Bookmark(String n,
                WordDescription w,
                int o)
Method Detail

toString

public String toString()
Overrides:
toString in class Object

compareTo

public int compareTo(Bookmark o)
Specified by:
compareTo in interface Comparable<Bookmark>

getName

public String getName()

getWord

public WordDescription getWord()
Word description of the word after this bookmark, null for none.

Returns:

getOffset

public int getOffset()

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object o)
Overrides:
equals in class Object