org.jmlspecs.models
Class JMLChar

java.lang.Object
  org.jmlspecs.models.JMLChar

All Implemented Interfaces:

Cloneable, Comparable, JMLComparable, JMLType, Serializable

public class JMLChar

extends Object

implements JMLComparable

A reflection of Character that implements JMLType.

Version:

$Revision: 1.26 $

Author:

Curtis Clifton with extensive input from the JML Seminar at Iowa State University, June-July 1999., Gary T. Leavens

See Also:

Character, JMLByte, JMLShort, JMLInteger, JMLLong, JMLString, JMLType

Class Specifications

public invariant this.owner == null; protected represents theChar <- this.value;

Specifications inherited from class Object

represents objectState <- org.jmlspecs.lang.JMLDataGroup.IT; public represents _getClass <- \typeof(this);

Specifications inherited from interface Comparable

instance public invariant ( \forall java.lang.Comparable x; x != null; x.compareTo(x) == 0); instance public invariant ( \forall java.lang.Comparable x, y; x != null&&y != null&&this.definedComparison(x,y)&&this.definedComparison(y,x); this.sgn(x.compareTo(y)) == -this.sgn(y.compareTo(x))); instance public invariant ( \forall int n; n == -1||n == 1; ( \forall java.lang.Comparable x, y, z; x != null&&y != null&&z != null&&this.definedComparison(x,y)&&this.definedComparison(y,z)&&this.definedComparison(x,z); this.sgn(x.compareTo(y)) == n&&this.sgn(y.compareTo(z)) == n ==> this.sgn(x.compareTo(z)) == n)); instance public invariant ( \forall int n; n == -1||n == 1; ( \forall java.lang.Comparable x, y, z; x != null&&y != null&&z != null&&this.definedComparison(x,y)&&this.definedComparison(y,z)&&this.definedComparison(x,z); (this.sgn(x.compareTo(y)) == 0&&this.sgn(y.compareTo(z)) == n||this.sgn(x.compareTo(y)) == n&&this.sgn(y.compareTo(z)) == 0) ==> this.sgn(x.compareTo(z)) == n)); instance public invariant ( \forall java.lang.Comparable x, y, z; x != null&&y != null&&z != null&&this.definedComparison(x,y)&&this.definedComparison(x,z)&&this.definedComparison(y,z); this.sgn(x.compareTo(y)) == 0 ==> this.sgn(x.compareTo(z)) == this.sgn(y.compareTo(z)));

Model Field Summary
char	theChar           The character that is the abstract value of this object.

 

Model fields inherited from class java.lang.Object

_getClass, objectState, theString

 

Ghost Field Summary

 

Ghost fields inherited from class java.lang.Object

objectTimesFinalized, owner

 

Field Summary
protected  char	value
static JMLChar	ZERO           The JMLChar that represents zero.

 

Constructor Summary

JMLChar()           Initialize this to contain the null character.

JMLChar(char c)           Initialize this to contain the given character.

JMLChar(non_null Character inChar)           Initialize this to contain the character contained in the given Character.

 

Model Method Summary

 

Model methods inherited from class java.lang.Object

hashValue

 

Model methods inherited from interface java.lang.Comparable

definedComparison, sgn

 

Method Summary
char	charValue()           Return the character contained in this object.
Object	clone()           Return a clone of this object.
int	compareTo(non_null Object op2)           Compare this to op2, returning a comparison code.
JMLChar	dividedBy(non_null JMLChar i2)           Return a new object containing the quotient of this object's char value divided by that of the given argument.
boolean	equals(nullable Object obj)           Test whether this object's value is equal to the given argument.
Character	getChar()           Return a Character object containing this object's character.
boolean	greaterThan(non_null JMLChar i2)           Tell whether this this object's char value is strictly greater than that of the given argument.
boolean	greaterThanOrEqualTo(non_null JMLChar i2)           Tell whether this this object's char value is greater than or equal to that of the given argument.
int	hashCode()           Return a hash code for this object.
int	intValue()           Return the integer corresponding to this character.
boolean	lessThan(non_null JMLChar i2)           Tell whether this this object's char value is strictly less than that of the given argument.
boolean	lessThanOrEqualTo(non_null JMLChar i2)           Tell whether this this object's char value is less than or equal to that of the given argument.
JMLChar	minus(non_null JMLChar i2)           Return a new object containing the difference between of this object's char value and that of the given argument.
JMLChar	plus(non_null JMLChar i2)           Return a new object containing the sum of this object's char value and that of the given argument.
JMLChar	remainderBy(non_null JMLChar i2)           Return a new object containing the remainder of this object's char value divided by that of the given argument.
JMLChar	times(non_null JMLChar i2)           Return a new object containing the product of this object's char value and that of the given argument.
String	toString()           Return a string representation of this object.

 

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

 

Model Field Detail

theChar

public char theChar

The character that is the abstract value of this object.

Specifications:
datagroup contains: value

value

protected final char value

Specifications:
is in groups: theChar

ZERO

public static final JMLChar ZERO

The JMLChar that represents zero.

JMLChar

public JMLChar()

Initialize this to contain the null character.

Specifications: (class)pure

public normal_behavior
assignable theChar, owner;
ensures this.theChar == 0;

JMLChar

public JMLChar(char c)

Initialize this to contain the given character.

Specifications: (class)pure

public normal_behavior
assignable theChar, owner;
ensures this.theChar == c;

JMLChar

public JMLChar(non_null Character inChar)

Initialize this to contain the character contained in the given Character.

Specifications: (class)pure

public normal_behavior
requires inChar != null;
assignable theChar, owner;
ensures this.theChar == inChar.charValue();

clone

public Object clone()

Return a clone of this object.

Specified by:

clone in interface JMLType

Overrides:

clone in class Object

Specifications: (class)pure

     also

public normal_behavior
ensures \result instanceof org.jmlspecs.models.JMLChar&&((org.jmlspecs.models.JMLChar)\result ).equals(this);

Specifications inherited from overridden method in class Object:
       non_null

protected normal_behavior
requires this instanceof java.lang.Cloneable;
assignable \nothing;
ensures \result != null;
ensures \typeof(\result ) == \typeof(this);
ensures (* \result is a clone of this *);

     also

protected normal_behavior
requires this.getClass().isArray();
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((java.lang.Object[])\result ).length == ((java.lang.Object[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((java.lang.Object[])this).length; ((java.lang.Object[])\result )[i] == ((java.lang.Object[])this)[i]);

     also

requires this.getClass().isArray();
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures java.lang.reflect.Array.getLength(\result ) == java.lang.reflect.Array.getLength(this);
ensures ( \forall int i; 0 <= i&&i < java.lang.reflect.Array.getLength(this); ( \exists java.lang.Object result_i; result_i == java.lang.reflect.Array.get(\result ,i); (result_i == null&&java.lang.reflect.Array.get(this,i) == null)||(result_i != null&&result_i.equals(java.lang.reflect.Array.get(this,i)))));

     also

protected exceptional_behavior
requires !(this instanceof java.lang.Cloneable);
assignable \nothing;
signals_only java.lang.CloneNotSupportedException;

     also

protected normal_behavior
requires \elemtype(\typeof(this)) <: \type(java.lang.Object);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((java.lang.Object[])\result ).length == ((java.lang.Object[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((java.lang.Object[])this).length; ((java.lang.Object[])\result )[i] == ((java.lang.Object[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(int);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((int[])\result ).length == ((int[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((int[])this).length; ((int[])\result )[i] == ((int[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(byte);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((byte[])\result ).length == ((byte[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((byte[])this).length; ((byte[])\result )[i] == ((byte[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(char);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((char[])\result ).length == ((char[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((char[])this).length; ((char[])\result )[i] == ((char[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(long);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((long[])\result ).length == ((long[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((long[])this).length; ((long[])\result )[i] == ((long[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(short);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((short[])\result ).length == ((short[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((short[])this).length; ((short[])\result )[i] == ((short[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(boolean);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((boolean[])\result ).length == ((boolean[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((boolean[])this).length; ((boolean[])\result )[i] == ((boolean[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(float);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((float[])\result ).length == ((float[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((float[])this).length; (java.lang.Float.isNaN(((float[])\result )[i])&&java.lang.Float.isNaN(((float[])this)[i]))||((float[])\result )[i] == ((float[])this)[i]);

     also

protected normal_behavior
requires \elemtype(\typeof(this)) == \type(double);
assignable \nothing;
ensures \elemtype(\typeof(\result )) == \elemtype(\typeof(this));
ensures ((double[])\result ).length == ((double[])this).length;
ensures ( \forall int i; 0 <= i&&i < ((double[])this).length; (java.lang.Double.isNaN(((double[])\result )[i])&&java.lang.Double.isNaN(((double[])this)[i]))||((double[])\result )[i] == ((double[])this)[i]);

Specifications inherited from overridden method in interface JMLType:
       pure

     also

public normal_behavior
ensures \result != null;
ensures \result instanceof org.jmlspecs.models.JMLType;
ensures ((org.jmlspecs.models.JMLType)\result ).equals(this);

    implies_that

ensures \result != null&&\typeof(\result ) <: \type(org.jmlspecs.models.JMLType);

charValue

public char charValue()

Return the character contained in this object.

Specifications: (class)pure

public normal_behavior
ensures \result == this.theChar;

getChar

public Character getChar()

Return a Character object containing this object's character.

Specifications: (class)pure

public normal_behavior
ensures \result != null&&\result .equals(new java.lang.Character(this.theChar));

hashCode

public int hashCode()

Return a hash code for this object.

Specified by:

hashCode in interface JMLType

Overrides:

hashCode in class Object

Specifications: (class)pure

     also

public normal_behavior
ensures \result >= 0&&(* \result is a hash code for theChar *);

Specifications inherited from overridden method in class Object:

public behavior
assignable objectState;
ensures (* \result is a hash code for this object *);

     also

public code normal_behavior
assignable \nothing;

Specifications inherited from overridden method in interface JMLType:
       pure

compareTo

public int compareTo(non_null Object op2)
              throws NullPointerException,
                     ClassCastException

Compare this to op2, returning a comparison code.

Specified by:

compareTo in interface JMLComparable

Parameters:

op2 - the object this is compared to.

Throws:

ClassCastException - when o is not a JMLChar.

NullPointerException

Specifications: (class)pure

     also

public normal_behavior
requires op2 instanceof org.jmlspecs.models.JMLChar;
ensures (this.theChar < ((org.jmlspecs.models.JMLChar)op2).theChar ==> \result == -1)&&(this.theChar == ((org.jmlspecs.models.JMLChar)op2).theChar ==> \result == 0)&&(this.theChar > ((org.jmlspecs.models.JMLChar)op2).theChar ==> \result == 1);

     also

public exceptional_behavior
requires op2 != null&&!(op2 instanceof org.jmlspecs.models.JMLChar);
signals_only java.lang.ClassCastException;

Specifications inherited from overridden method compareTo(Object o) in interface JMLComparable:
       (class)pure

     also

public behavior
requires o != null;
ensures (* o is an instance of a comparable class *);
ensures (* if this is equal to o, then \result is 0 *)&&(* if this is less than o, then \result is negative *)&&(* if this is greater than o, then \result is positive *);
signals_only java.lang.ClassCastException;
signals (java.lang.ClassCastException) (* o is not an instance of a comparable class *);

Specifications inherited from overridden method compareTo(Object o) in interface Comparable:
       pure

public behavior
requires o != null;
ensures (* \result is negative if this is "less than" o *);
ensures (* \result is 0 if this is "equal to" o *);
ensures (* \result is positive if this is "greater than" o *);
signals_only java.lang.ClassCastException;
signals (java.lang.ClassCastException) (* the class of o prohibits it from being compared to this *);

     also

public behavior
requires o != null&&o instanceof java.lang.Comparable;
ensures this.definedComparison((java.lang.Comparable)o,this);
ensures o == this ==> \result == 0;
ensures this.sgn(\result ) == -this.sgn(((java.lang.Comparable)o).compareTo(this));
signals (java.lang.ClassCastException) !this.definedComparison((java.lang.Comparable)o,this);

equals

public boolean equals(nullable Object obj)

Test whether this object's value is equal to the given argument.

Specified by:

equals in interface JMLType

Overrides:

equals in class Object

Specifications: (class)pure

     also

public normal_behavior
requires (obj != null&&obj instanceof org.jmlspecs.models.JMLChar);
ensures \result <==> ((org.jmlspecs.models.JMLChar)obj).theChar == this.theChar;

     also

requires obj == null||!(obj instanceof org.jmlspecs.models.JMLChar);
ensures !\result ;

Specifications inherited from overridden method equals(Object obj) in class Object:
       pure

public normal_behavior
requires obj != null;
ensures (* \result is true when obj is "equal to" this object *);

     also

public normal_behavior
requires this == obj;
ensures \result ;

     also

public code normal_behavior
requires obj != null;
ensures \result <==> this == obj;

     also

diverges false;
ensures obj == null ==> !\result ;

Specifications inherited from overridden method equals(Object ob2) in interface JMLType:
       pure

     also

public normal_behavior
ensures \result ==> ob2 != null&&(* ob2 is not distinguishable from this, except by using mutation or == *);

    implies_that

public normal_behavior

{|

requires ob2 != null&&ob2 instanceof org.jmlspecs.models.JMLType;
ensures ((org.jmlspecs.models.JMLType)ob2).equals(this) == \result ;

also

requires ob2 == this;
ensures \result <==> true;

|}

toString

public String toString()

Return a string representation of this object.

Overrides:

toString in class Object

Specifications: (class)pure

     also

public normal_behavior
ensures \result != null&&\result .equals(java.lang.String.valueOf(this.theChar));

    implies_that

public normal_behavior
ensures \result != null&&\result .equals(this.getChar().toString());

Specifications inherited from overridden method in class Object:
       non_null

public normal_behavior
assignable objectState;
ensures \result != null&&\result .equals(this.theString);
ensures (* \result is a string representation of this object *);

     also

public code normal_behavior
assignable \nothing;
ensures \result != null&&(* \result is the instance's class name, followed by an @, followed by the instance's hashcode in hex *);

     also

public code model_program { ... }

    implies_that

assignable objectState;
ensures \result != null;

intValue

public int intValue()

Return the integer corresponding to this character.

Specifications: (class)pure

public normal_behavior
ensures \result == this.theChar;

plus

public JMLChar plus(non_null JMLChar i2)

Return a new object containing the sum of this object's char value and that of the given argument.

Specifications: non_null (class)pure

public normal_behavior
requires i2 != null;
ensures \result != null;
ensures \result .theChar == (char)(this.theChar+i2.theChar);

minus

public JMLChar minus(non_null JMLChar i2)

Return a new object containing the difference between of this object's char value and that of the given argument.

Specifications: non_null (class)pure

public normal_behavior
requires i2 != null;
ensures \result != null;
ensures \result .theChar == (char)(this.theChar-i2.theChar);

times

public JMLChar times(non_null JMLChar i2)

Return a new object containing the product of this object's char value and that of the given argument.

Specifications: non_null (class)pure

public normal_behavior
requires i2 != null;
ensures \result != null;
ensures \result .theChar == (char)(this.theChar*i2.theChar);

dividedBy

public JMLChar dividedBy(non_null JMLChar i2)

Return a new object containing the quotient of this object's char value divided by that of the given argument.

Specifications: non_null (class)pure

public normal_behavior
requires i2 != null&&i2.theChar != 0;
ensures \result != null;
ensures \result .theChar == (char)(this.theChar/i2.theChar);

remainderBy

public JMLChar remainderBy(non_null JMLChar i2)

Return a new object containing the remainder of this object's char value divided by that of the given argument.

Specifications: non_null (class)pure

public normal_behavior
requires i2 != null&&i2.theChar != 0;
ensures \result != null;
ensures \result .theChar == (char)(this.theChar%i2.theChar);

greaterThan

public boolean greaterThan(non_null JMLChar i2)

Tell whether this this object's char value is strictly greater than that of the given argument.

Specifications: (class)pure

public normal_behavior
requires i2 != null;
ensures \result <==> this.theChar > i2.theChar;

lessThan

public boolean lessThan(non_null JMLChar i2)

Tell whether this this object's char value is strictly less than that of the given argument.

Specifications: (class)pure

public normal_behavior
requires i2 != null;
ensures \result <==> this.theChar < i2.theChar;

greaterThanOrEqualTo

public boolean greaterThanOrEqualTo(non_null JMLChar i2)

Tell whether this this object's char value is greater than or equal to that of the given argument.

Specifications: (class)pure

public normal_behavior
requires i2 != null;
ensures \result <==> this.theChar >= i2.theChar;

lessThanOrEqualTo

public boolean lessThanOrEqualTo(non_null JMLChar i2)

Tell whether this this object's char value is less than or equal to that of the given argument.

Specifications: (class)pure

public normal_behavior
requires i2 != null;
ensures \result <==> this.theChar <= i2.theChar;