PIEnum#

Represents an instance of an EXPRESS enumeration type.

Wraps an integer value and uses an IEnumDescriptor to map between integer values and their string representations as defined in the schema.

Constructors#

PIEnum()#

Constructs an enumeration instance from a descriptor.

Optionally initializes the enumeration to the integer value (defaults to 0).

PIEnum(this.descriptor, [this.value = 0]);

PIEnum.nullEnum() factory#

Creates a null enumeration instance.

The returned instance uses a NullEnumDescriptor and has its value set to 0.

factory PIEnum.nullEnum() {
  return PIEnum(NullEnumDescriptor());
}

Properties#

descriptor final#

The descriptor that defines the valid values and their names for this type.

final IEnumDescriptor descriptor;

hashCode no setter override#

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

@override
int get hashCode => Object.hash(typeId, value);

isNull no setter override#

Whether this enumeration is considered null.

An enumeration is null if its descriptor is null.

@override
bool get isNull => descriptor.isNull;

runtimeType no setter inherited#

A representation of the runtime type of the object.

Inherited from Object.

external Type get runtimeType;

stringValue no setter#

The string representation of the current integer value.

Returns the symbolic name of the value as defined by the descriptor. If the enum is null (see isNull), the behavior is defined by the descriptor.

String get stringValue => descriptor.getValue(value);

typeId no setter#

The unique type identifier for this enumeration type.

Returns the descriptor's typeId. Returns 0 if the enum is null.

int get typeId => descriptor.isNull ? 0 : descriptor.typeId;

value read / write#

getter:

The current integer value of this enumeration instance.

setter:

The current integer value of this enumeration instance.

int value;

Methods#

fromInt()#

Creates a new PIEnum instance from an integer value intVal.

Returns a new instance set to intVal. Note: A value of 0 typically represents PI_NULL, indicating the enumeration value is unset. If this enum is null, returns an instance set to 0.

PIEnum fromInt(int intVal) {
  if (descriptor.isNull) {
    return PIEnum(descriptor, 0);
  }
  return PIEnum(descriptor, intVal);
}

fromString()#

Creates a new PIEnum instance from a string value strVal.

Looks up the integer index of strVal using the descriptor and returns a new instance set to that value. If strVal is not found or this enum is null, returns an instance set to 0 (PI_NULL).

PIEnum fromString(String strVal) {
  if (descriptor.isNull) {
    return PIEnum(descriptor, 0);
  }
  final iValue = descriptor.getValueIndex(toTypeId(strVal));
  return PIEnum(descriptor, iValue);
}

noSuchMethod() inherited#

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

nullify()#

Sets the current value of this instance to 0 (PI_NULL).

void nullify() {
  value = 0;
}

stringValues()#

Returns a list of all valid string values for this enumeration.

The list includes all values defined by the descriptor. If the enum is null, returns an empty list.

List<String> stringValues() {
  if (descriptor.isNull) {
    return [];
  }
  final count = descriptor.valueCount;
  if (count < 2) {
    return ['PI_NULL'];
  }
  final result = <String>[];
  for (int i = 0; i < count; ++i) {
    result.add(descriptor.getValue(i));
  }
  return result;
}

toString() inherited#

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Object.

external String toString();

Operators#

operator ==() override#

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

• Total: It must return a boolean for all arguments. It should never throw.

• Reflexive: For all objects o, o == o must be true.

• Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

• Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

@override
bool operator ==(Object other) {
  if (identical(this, other)) return true;
  return other is PIEnum && other.typeId == typeId && other.value == value;
}