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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of permazen-core Show documentation
Permazen core API classes which provide objects, fields, indexes, queries, and schema management on top of a key/value store.
The newest version!

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

package io.permazen.schema;

/**
 * Visitor pattern interface for {@link SchemaField}s.
 *
 * @param  switch method return type
 * @see SchemaField#visit
 */
public interface SchemaFieldSwitch {

    /**
     * Handle a {@link SetSchemaField}.
     *
     * 
     * The implementation in {@link SchemaFieldSwitch} delegates to {@link #caseCollectionSchemaField caseCollectionSchemaField()}.
     *
     * @param field visiting field
     * @return visitor return value
     */
    default R caseSetSchemaField(SetSchemaField field) {
        return this.caseCollectionSchemaField(field);
    }

    /**
     * Handle a {@link ListSchemaField}.
     *
     * 

     * The implementation in {@link SchemaFieldSwitch} delegates to {@link #caseCollectionSchemaField caseCollectionSchemaField()}.
     *
     * @param field visiting field
     * @return visitor return value
     */
    default R caseListSchemaField(ListSchemaField field) {
        return this.caseCollectionSchemaField(field);
    }

    /**
     * Handle a {@link MapSchemaField}.
     *
     * 

     * The implementation in {@link SchemaFieldSwitch} delegates to {@link #caseComplexSchemaField caseComplexSchemaField()}.
     *
     * @param field visiting field
     * @return visitor return value
     */
    default R caseMapSchemaField(MapSchemaField field) {
        return this.caseComplexSchemaField(field);
    }

    /**
     * Handle a {@link SimpleSchemaField}.
     *
     * 

     * The implementation in {@link SchemaFieldSwitch} delegates to {@link #caseDefault caseDefault()}.
     *
     * @param field visiting field
     * @return visitor return value
     */
    default R caseSimpleSchemaField(SimpleSchemaField field) {
        return this.caseDefault(field);
    }

    /**
     * Handle a {@link ReferenceSchemaField}.
     *
     * 

     * The implementation in {@link SchemaFieldSwitch} delegates to {@link #caseSimpleSchemaField caseSimpleSchemaField()}.
     *
     * @param field visiting field
     * @return visitor return value
     */
    default R caseReferenceSchemaField(ReferenceSchemaField field) {
        return this.caseSimpleSchemaField(field);
    }

    /**
     * Handle a {@link EnumSchemaField}.
     *
     * 

     * The implementation in {@link SchemaFieldSwitch} delegates to {@link #caseSimpleSchemaField caseSimpleSchemaField()}.
     *
     * @param field visiting field
     * @return visitor return value
     */
    default R caseEnumSchemaField(EnumSchemaField field) {
        return this.caseSimpleSchemaField(field);
    }

    /**
     * Handle a {@link EnumArraySchemaField}.
     *
     * 

     * The implementation in {@link SchemaFieldSwitch} delegates to {@link #caseSimpleSchemaField caseSimpleSchemaField()}.
     *
     * @param field visiting field
     * @return visitor return value
     */
    default R caseEnumArraySchemaField(EnumArraySchemaField field) {
        return this.caseSimpleSchemaField(field);
    }

    /**
     * Handle a {@link CounterSchemaField}.
     *
     * 

     * The implementation in {@link SchemaFieldSwitch} delegates to {@link #caseDefault caseDefault()}.
     *
     * @param field visiting field
     * @return visitor return value
     */
    default R caseCounterSchemaField(CounterSchemaField field) {
        return this.caseDefault(field);
    }

    /**
     * Visitor pattern roll-up method.
     *
     * 

     * The implementation in {@link SchemaFieldSwitch} delegates to {@link #caseComplexSchemaField caseComplexSchemaField()}.
     *
     * @param field visiting field
     * @return visitor return value
     */
    default R caseCollectionSchemaField(CollectionSchemaField field) {
        return this.caseComplexSchemaField(field);
    }

    /**
     * Visitor pattern roll-up method.
     *
     * 

     * The implementation in {@link SchemaFieldSwitch} delegates to {@link #caseDefault caseDefault()}.
     *
     * @param field visiting field
     * @return visitor return value
     */
    default R caseComplexSchemaField(ComplexSchemaField field) {
        return this.caseDefault(field);
    }

    /**
     * Visitor pattern roll-up method.
     *
     * 
     * The implementation in {@link SchemaFieldSwitch} always throws {@link UnsupportedOperationException}.
     *
     * @param field visiting field
     * @return visitor return value
     */
    default R caseDefault(SchemaField field) {
        throw new UnsupportedOperationException(String.format("field type not handled: %s", field));
    }
}