org.nlogo.api.Syntax

Specifies the arguments accepted by a primitive. Used by the compiler for type-checking.

You cannot instantiate this class directly. Instead, use the static construction methods Syntax.commandSyntax(...) or Syntax.reporterSyntax(...).

For example, in a Reporter that takes two number arguments and returns a boolean, implement Primitive.getSyntax() as follows:

public Syntax getSyntax() {
  return Syntax.reporterSyntax(
    new int[] { Syntax.NumberType(), Syntax.NumberType() },
    Syntax.BooleanType());
}

An input can be made variadic, meaning that it can be repeated any number of times when enclosed in parentheses, if you add the RepeatableType flag. When using variadic inputs you should also define the default number of inputs, that is, the number of inputs expect if the user does not use parentheses. For example:

 public Syntax getSyntax() {
   return Syntax.reporterSyntax(
     new int[] { Syntax.WildcardType() | Syntax.RepeatableType() },
     Syntax.ListType(), 2);
 }

Source: Syntax.scala
See also: Primitive#getSyntax()

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new Syntax(precedence: Int, left: Int = Syntax.VoidType, right: Array[Int] = ..., ret: Int = Syntax.VoidType, defaultOption: Option[Int] = scala.None, minimumOption: Option[Int] = scala.None, isRightAssociative: Boolean = false, agentClassString: String = "OTPL", blockAgentClassString: String = null, switches: Boolean = false)

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
val agentClassString: String
final def asInstanceOf[T0]: T0

Definition Classes
Any
val blockAgentClassString: String
def canEqual(arg0: Any): Boolean

Definition Classes
Syntax → Equals
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
val defaultOption: Option[Int]
def dfault: Int
def dump: String
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
Syntax → Equals → AnyRef → Any
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
final def getClass(): java.lang.Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
Syntax → AnyRef → Any
def isInfix: Boolean

indicates whether this instruction should be parsed as infix.
indicates whether this instruction should be parsed as infix. Infix instructions expect exactly one argument on the left and should not be variadic on the right.
returns
true if this instruction is infix, false otherwise.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val isRightAssociative: Boolean
val left: Int
def minimum: Int
val minimumOption: Option[Int]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val precedence: Int
def productArity: Int

Definition Classes
Syntax → Product
def productElement(arg0: Int): Any

Definition Classes
Syntax → Product
def productIterator: Iterator[Any]

Definition Classes
Product
def productPrefix: String

Definition Classes
Syntax → Product
val ret: Int
val right: Array[Int]
def rightDefault: Int

returns the number of args this instruction takes on the right by default.
val switches: Boolean
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def takesOptionalCommandBlock: Boolean
def toString(): String

Definition Classes
Syntax → AnyRef → Any
def totalDefault: Int

returns the total number of args, left and right, this instruction takes by default.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws()

Deprecated Value Members

def productElements: Iterator[Any]

Definition Classes
Product
Annotations
@deprecated
Deprecated
(Since version 2.8.0) use productIterator instead

Syntax

case class Syntax(precedence: Int, left: Int, right: Array[Int], ret: Int, defaultOption: Option[Int], minimumOption: Option[Int], isRightAssociative: Boolean, agentClassString: String, blockAgentClassString: String, switches: Boolean) extends Product with Serializable

Instance Constructors

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

val agentClassString: String

final def asInstanceOf[T0]: T0

val blockAgentClassString: String

def canEqual(arg0: Any): Boolean

def clone(): AnyRef

val defaultOption: Option[Int]

def dfault: Int

def dump: String

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): java.lang.Class[_]

def hashCode(): Int

def isInfix: Boolean

final def isInstanceOf[T0]: Boolean

val isRightAssociative: Boolean

val left: Int

def minimum: Int

val minimumOption: Option[Int]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val precedence: Int

def productArity: Int

def productElement(arg0: Int): Any

def productIterator: Iterator[Any]

def productPrefix: String

val ret: Int

val right: Array[Int]

def rightDefault: Int

val switches: Boolean

final def synchronized[T0](arg0: ⇒ T0): T0

def takesOptionalCommandBlock: Boolean

def toString(): String

def totalDefault: Int

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Deprecated Value Members

def productElements: Iterator[Any]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any