// This Source Code is in the Public Domain per: http://unlicense.org
package org.litesoft.core.simpletypes;

import org.litesoft.commonfoundation.base.*;
import org.litesoft.core.simpletypes.nonpublic.*;

/**
 * TextLine is Immutable and carries a non-null String that may ONLY contain characters that do NOT satisfy Character.isISOControl( (char/int)c )
 */
public final class TextLine extends CompareSupport<TextLine> implements SimpleType {
    private static final long serialVersionUID = 1L;

    private /* final */ String mLine;

    @SuppressWarnings({"deprecation", "UnusedDeclaration"})
    @Deprecated
    /** for Serialization */
    protected TextLine() {
    }

    public TextLine( String pLine ) {
        Confirm.isNotNull( "Line", mLine = pLine );
        for ( int i = 0; i < mLine.length(); i++ ) {
            if ( isISOControl( mLine.charAt( i ) ) ) {
                throw new IllegalArgumentException( "Character (@ + " + i + ") is an ISO Control character" );
            }
        }
    }

    /**
     * Duplicated out of Character.isISOControl, as not supported in GWT
     */
    private boolean isISOControl( int codePoint ) {
        return (codePoint >= 0x0000 && codePoint <= 0x001F) || //
               (codePoint >= 0x007F && codePoint <= 0x009F);
    }

    public String getLine() {
        return mLine;
    }

    public boolean equals( Object o ) {
        return (this == o) || //
               ((o instanceof TextLine) && equals( (TextLine) o ));
    }

    public boolean equals( TextLine them ) {
        return (this == them) || //
               ((them != null) //
                && equal( this.mLine, them.mLine ) //
               );
    }

    public int hashCode() {
        return mLine.hashCode();
    }

    public int compareTo( TextLine them ) {
        return this.mLine.compareTo( them.mLine );
    }

    public String toString() {
        return mLine;
    }
}