io.github.prolobjectlink.prolog

Interface PrologAtom

All Superinterfaces:

Comparable<PrologTerm>, PrologElement, PrologTerm

public interface PrologAtom
extends PrologTerm

Represent the Prolog atom data type. Prolog atoms are can be of two kinds simple or complex. Simple atoms are defined like a single alpha numeric word that begin like initial lower case character. The complex atom are define like any character sequence that begin and end with simple quotes.

The string passed to build a simple atoms should be match with [a-z][A-Za-z0-9_]* regular expression. If the string passed to build an atom don't match with the before mentioned regular expression the atom constructor can be capable of create a complex atom automatically.

For complex atom the string value can have the quotes or just can be absent. The printed string representation of the complex atom implementation set the quotes if they are needed.

The Prolog Provider is the mechanism to create a new Prolog atoms invoking PrologProvider.newAtom(String).

Two atoms are equals if and only if are atoms and have equals functor (value). Atoms terms unify only with same atoms or with free variable.

Since:

1.0

Author:

Jose Zalacain

Method Summary

Modifier and Type	Method and Description
String	getStringValue() String value for atom term.
void	setStringValue(String value) Set the string value for this atom instance.

Methods inherited from interface io.github.prolobjectlink.prolog.PrologTerm

cast, getArgument, getArguments, getArity, getFunctor, getIndicator, getObject, getProvider, getTerm, getType, hasIndicator, isAtom, isAtomic, isClass, isCompound, isDouble, isEmptyList, isEntry, isEvaluable, isFalseType, isField, isFloat, isInteger, isList, isLong, isMap, isMixin, isNil, isNullType, isNumber, isObjectType, isParameter, isReference, isResult, isStructure, isTrueType, isVariable, isVariableBound, isVariableNotBound, isVoidType, match, unify

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface io.github.prolobjectlink.prolog.PrologElement

isClause, isTerm

Method Detail

getStringValue

String getStringValue()

String value for atom term.

Returns:

value for atom term.

Since:

1.0

setStringValue

void setStringValue(String value)

Set the string value for this atom instance. The string value should be match with [a-z][A-Za-z0-9_]* regular expression. If the string passed to build an atom don't match with the before mentioned regular expression the atom constructor can be capable of create a complex atom automatically.

Parameters:

value - string value for this atom

Since:

1.0