HebrewLetter.java

package com.tyndalehouse.step.core.utils.language.hebrew;

/**
 * A collection of enums to identify properties of the letter
 * 
 * @author chrisburrell
 * 
 */
public class HebrewLetter {
    private HebrewLetterType hebrewLetterType = null;
    private SoundingType soundingType = null;
    private ConsonantType consonantType = null;
    private VowelStressType vowelStressType = null;
    private VowelLengthType vowelLengthType = null;
    private boolean shureq = false;
    private final char c;
    private boolean transliterable = true;
    private boolean isShin = false;

    /**
     * The character it is representing
     * 
     * @param c the character
     */
    public HebrewLetter(final char c) {
        this.c = c;
    }

    /**
     * @return true if is a vowel
     */
    public boolean isVowel() {
        return HebrewLetterType.VOWEL == this.hebrewLetterType;
    }

    /**
     * @return true if is a consonant
     */
    public boolean isConsonant() {
        return HebrewLetterType.CONSONANT == this.hebrewLetterType;
    }

    /**
     * @return true if no dagesh on the letter
     */
    public boolean hasNoDagesh() {
        return this.consonantType == ConsonantType.NO_DAGESH;
    }

    /**
     * @return true if consontant type is DOUBLE
     */
    public boolean isDoubled() {
        return this.consonantType == ConsonantType.DOUBLE;
    }

    /**
     * @return true if long
     */
    public boolean isLong() {
        return this.vowelLengthType == VowelLengthType.LONG;
    }

    /**
     * @return true if stressed
     */
    public boolean isStressed() {
        return this.vowelStressType == VowelStressType.STRESSED;
    }

    /**
     * @return true if silent
     */
    public boolean isSilent() {
        return this.soundingType == SoundingType.SILENT;
    }

    /**
     * @return the hebrewLetterType
     */
    public HebrewLetterType getHebrewLetterType() {
        return this.hebrewLetterType;
    }

    /**
     * @param hebrewLetterType the hebrewLetterType to set
     */
    public void setHebrewLetterType(final HebrewLetterType hebrewLetterType) {
        this.hebrewLetterType = hebrewLetterType;
    }

    /**
     * @return the soundingType
     */
    public SoundingType getSoundingType() {
        return this.soundingType;
    }

    /**
     * @param soundingType the soundingType to set
     */
    public void setSoundingType(final SoundingType soundingType) {
        this.soundingType = soundingType;
    }

    /**
     * @return the consonantType
     */
    public ConsonantType getConsonantType() {
        return this.consonantType;
    }

    /**
     * @param consonantType the consonantType to set
     */
    public void setConsonantType(final ConsonantType consonantType) {
        this.consonantType = consonantType;
    }

    /**
     * @return the vowelStressType
     */
    public VowelStressType getVowelStressType() {
        return this.vowelStressType;
    }

    /**
     * @param vowelStressType the vowelStressType to set
     */
    public void setVowelStressType(final VowelStressType vowelStressType) {
        this.vowelStressType = vowelStressType;
    }

    /**
     * @return the vowelLengthType
     */
    public VowelLengthType getVowelLengthType() {
        return this.vowelLengthType;
    }

    /**
     * @param vowelLengthType the vowelLengthType to set
     */
    public void setVowelLengthType(final VowelLengthType vowelLengthType) {
        this.vowelLengthType = vowelLengthType;
    }

    /**
     * @return the c
     */
    public char getC() {
        return this.c;
    }

    /**
     * @return the shureq
     */
    public boolean isShureq() {
        return this.shureq;
    }

    /**
     * @param shureq the shureq to set
     */
    public void setShureq(final boolean shureq) {
        this.shureq = shureq;
    }

    public void setIsShin(final boolean shin) {
        isShin = shin;
    }

    public boolean isShin() {
        return isShin;
    }

    /**
     * @param shin true to indicate SHIN
     */
    public void setShin(final boolean shin) {
        isShin = shin;
    }
}