io.permazen.core.EnumField Maven / Gradle / Ivy
/*
* Copyright (C) 2015 Archie L. Cobbs. All rights reserved.
*/
package io.permazen.core;
import io.permazen.core.type.EnumFieldType;
import java.util.List;
/**
* A field that contains one entry in an ordered list of unique {@link String} identifiers.
*
*
* Two instances of this class are considered compatible only when their ordered lists of identifiers are identical.
*/
public class EnumField extends SimpleField {
/**
* Constructor.
*
* @param name the name of the field
* @param storageId field storage ID
* @param schema schema version
* @param idents the unique enum identifiers
* @param indexed whether this field is indexed
* @throws IllegalArgumentException if any parameter is null
* @throws IllegalArgumentException if {@code name} is invalid
* @throws IllegalArgumentException if {@code storageId} is invalid
* @throws IllegalArgumentException if any identifier in {@code idents} is null, duplicate, or not a valid Java identifier
*/
EnumField(String name, int storageId, Schema schema, boolean indexed, List idents) {
super(name, storageId, schema, new EnumFieldType(idents), indexed);
}
// Public methods
/**
* Get the {@link EnumFieldType} associated with this instance.
*/
@Override
public EnumFieldType getFieldType() {
return (EnumFieldType)super.getFieldType();
}
@Override
public R visit(FieldSwitch target) {
return target.caseEnumField(this);
}
@Override
public String toString() {
return "enum field `" + this.name + "'";
}
}