Package jline.api.sn

Class SnContract

java.lang.Object

jline.api.sn.SnContract

public final class SnContract
extends Object

The NetworkStruct contract: every field a NetworkStruct may carry.

GENERATED by doc/generate-sn-contract.py from doc/line-sn-contract.json. Do not edit.

Fields are keyed by their MATLAB name; SnContract.Field.javaName is the field of NetworkStruct that carries it here, null when the JAR does not store it (SnContract.Field.absent then says why). Shapes use the grammar of the json's "shapes" entry. SnContractValidate checks a struct against this table.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SnContract.Field	One NetworkStruct field.

Method Summary

Modifier and Type	Method	Description
static SnContract.Field	byJavaName(String javaName)	The field the JAR stores under javaName; null when the contract does not declare it.
static Map<String,SnContract.Field>	fields()	Every field, by its MATLAB name.
static Map<String,Class<?>[]>	nativeFields()	JAR-only fields (no MATLAB twin) and the types they may hold.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

fields

public static Map<String,SnContract.Field> fields()

Every field, by its MATLAB name.

byJavaName

public static SnContract.Field byJavaName(String javaName)

The field the JAR stores under javaName; null when the contract does not declare it.

nativeFields

public static Map<String,Class<?>[]> nativeFields()

JAR-only fields (no MATLAB twin) and the types they may hold.