Integer

java.lang.Object
- org.jpl7.Term
- - org.jpl7.Integer

```
public class Integer
extends Term
```
Integer is a specialised Term with a long field, representing a Prolog integer value.
```
 Integer i = new Integer(1024);
 
```
Once constructed, the value of an Integer instance cannot be altered. An Integer can be used (and re-used) as an argument of Compounds. Beware confusing jpl.Integer with java.lang.Integer.
Copyright (C) 2004 Paul Singleton
Copyright (C) 1998 Fred Dushin
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This library 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 Library Public License for more details.
See Also:

Term, Compound

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.math.BigInteger`	`bigValue` the Integer's immutable BigInteger value, iff too big for a long
`protected long`	`value` the Integer's immutable long value, iff small enough

Constructor Summary

Constructors
Constructor and Description

Integer(java.math.BigInteger value)

Integer(long value)

Constructors
Constructor and Description
`Integer(java.math.BigInteger value)`
`Integer(long value)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Term[]`	`args()` the (zero) arguments of an Integer, as a (zero-length) Term[]
`java.math.BigInteger`	`bigValue()` Returns the value of this Integer as a java.math.BigInteger, whether or not it fits in a long
`double`	`doubleValue()` Returns the value of this Integer converted to a double
`boolean`	`equals(java.lang.Object obj)` two Integer instances are equal if they are the same object, or if their values are equal
`float`	`floatValue()` Returns the value of this Integer converted to a float
`boolean`	`hasFunctor(int val, int arity)` whether this Integer's functor has (int) 'name' and 'arity' (c.f. traditional functor/3)
`int`	`intValue()` Returns the value of this Integer as an int if possible, else throws a JPLException
`protected boolean`	`isBig()`
`java.lang.Object`	`jrefToObject()`
`long`	`longValue()` Returns the value of this Integer as a long
`protected void`	`put(java.util.Map<java.lang.String,term_t> varnames_to_vars, term_t term)` To convert an Integer into a Prolog term, we put its value into the term_t.
`java.lang.String`	`toString()` a Prolog source text representation of this Integer's value
`int`	`type()` the type of this term, as "Prolog.INTEGER"
`java.lang.String`	`typeName()` the name of the type of this term, as "Integer"

Methods inherited from class org.jpl7.Term
arg, arity, atomType, getSubst, getSubsts, getTerm, getTerm, hasFunctor, hasFunctor, isAtom, isBigInteger, isCompound, isFloat, isInteger, isJFalse, isJNull, isJObject, isJRef, isJTrue, isJVoid, isListNil, isListPair, isVariable, listLength, name, objectToJRef, put, putParams, putParams, putParams1, putParams2, putTerm, putTerms, terms_equals, toString, toTermArray

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - value
```
protected final long value
```
    the Integer's immutable long value, iff small enough
  - bigValue
```
protected final java.math.BigInteger bigValue
```
    the Integer's immutable BigInteger value, iff too big for a long
- Constructor Detail
  - Integer
```
public Integer(long value)
```
    Parameters:
    
    value - This Integer's intended (long) value
  - Integer
```
public Integer(java.math.BigInteger value)
```
    Parameters:
    
    value - This Integer's intended (BigInteger) value
- Method Detail
  - args
```
public Term[] args()
```
    the (zero) arguments of an Integer, as a (zero-length) Term[]
    
    Overrides:
    
    args in class Term
    
    Returns:
    
    the (zero) arguments of an Integer, as a (zero-length) Term[]
  - doubleValue
```
public final double doubleValue()
```
    Returns the value of this Integer converted to a double
    
    Overrides:
    
    doubleValue in class Term
    
    Returns:
    
    the value of this Integer converted to a double
  - equals
```
public final boolean equals(java.lang.Object obj)
```
    two Integer instances are equal if they are the same object, or if their values are equal
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - The Object to compare (not necessarily an Integer)
    
    Returns:
    
    true if the Object satisfies the above condition
  - floatValue
```
public final float floatValue()
```
    Returns the value of this Integer converted to a float
    
    Overrides:
    
    floatValue in class Term
    
    Returns:
    
    the value of this Integer converted to a float
  - hasFunctor
```
public final boolean hasFunctor(int val,
                                int arity)
```
    whether this Integer's functor has (int) 'name' and 'arity' (c.f. traditional functor/3)
    
    Overrides:
    
    hasFunctor in class Term
    
    Returns:
    
    whether this Integer's functor has (int) 'name' and 'arity'
  - intValue
```
public final int intValue()
```
    Returns the value of this Integer as an int if possible, else throws a JPLException
    
    Overrides:
    
    intValue in class Term
    
    Returns:
    
    the int value of this Integer
    
    Throws:
    
    JPLException - if the value of this Integer is too great to be represented as a Java int
  - isBig
```
protected final boolean isBig()
```
    Returns:
    
    whether this Integer's value is too big to represent as a long
  - jrefToObject
```
public java.lang.Object jrefToObject()
```
    Overrides:
    
    jrefToObject in class Term
  - longValue
```
public final long longValue()
```
    Returns the value of this Integer as a long
    
    Overrides:
    
    longValue in class Term
    
    Returns:
    
    the value of this Integer as a long
  - bigValue
```
public final java.math.BigInteger bigValue()
```
    Returns the value of this Integer as a java.math.BigInteger, whether or not it fits in a long
    
    Overrides:
    
    bigValue in class Term
    
    Returns:
    
    the value of this Integer as a java.math.BigInteger, whether or not it fits in a long
  - put
```
protected final void put(java.util.Map<java.lang.String,term_t> varnames_to_vars,
                         term_t term)
```
    To convert an Integer into a Prolog term, we put its value into the term_t.
    
    Specified by:
    
    put in class Term
    
    Parameters:
    
    varnames_to_vars - A Map from variable names to Prolog variables.
    
    term - A (previously created) term_t which is to be set to a Prolog integer
  - toString
```
public java.lang.String toString()
```
    a Prolog source text representation of this Integer's value
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a Prolog source text representation of this Integer's value
  - type
```
public final int type()
```
    the type of this term, as "Prolog.INTEGER"
    
    Specified by:
    
    type in class Term
    
    Returns:
    
    the type of this term, as "Prolog.INTEGER"
  - typeName
```
public java.lang.String typeName()
```
    the name of the type of this term, as "Integer"
    
    Specified by:
    
    typeName in class Term
    
    Returns:
    
    the name of the type of this term, as "Integer"

Class Integer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.jpl7.Term

Methods inherited from class java.lang.Object

Field Detail

value

bigValue

Constructor Detail

Integer

Integer

Method Detail

args

doubleValue

equals

floatValue

hasFunctor

intValue

isBig

jrefToObject

longValue

bigValue

put

toString

type

typeName