io.permazen.schema.SchemaField Maven / Gradle / Ivy

Go to download

/*
 * Copyright (C) 2015 Archie L. Cobbs. All rights reserved.
 */

package io.permazen.schema;

/**
 * A field in a {@link SchemaObjectType}.
 */
public abstract class SchemaField extends AbstractSchemaItem {

    /**
     * Apply visitor pattern.
     *
     * @param target target to invoke
     * @param  visitor return type
     * @return value from the method of {@code target} corresponding to this instance's type
     * @throws NullPointerException if {@code target} is null
     */
    public abstract  R visit(SchemaFieldSwitch target);

// Compatibility

    abstract boolean isCompatibleWith(SchemaField that);

// Object

    @Override
    public String toString() {
        return "field " + super.toString();
    }

// Cloneable

    @Override
    public SchemaField clone() {
        return (SchemaField)super.clone();
    }
}