io.evitadb.api.requestResponse.schema.mutation.AttributeSchemaMutation Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of evita_api Show documentation
Show all versions of evita_api Show documentation
Module contains external API of the evitaDB.
/*
*
* _ _ ____ ____
* _____ _(_) |_ __ _| _ \| __ )
* / _ \ \ / / | __/ _` | | | | _ \
* | __/\ V /| | || (_| | |_| | |_) |
* \___| \_/ |_|\__\__,_|____/|____/
*
* Copyright (c) 2023
*
* Licensed under the Business Source License, Version 1.1 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://github.com/FgForrest/evitaDB/blob/master/LICENSE
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.evitadb.api.requestResponse.schema.mutation;
import io.evitadb.api.requestResponse.schema.AttributeSchemaContract;
import io.evitadb.api.requestResponse.schema.CatalogSchemaContract;
import io.evitadb.api.requestResponse.schema.EntitySchemaContract;
import io.evitadb.api.requestResponse.schema.ReferenceSchemaContract;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.ThreadSafe;
/**
* This interface marks all implementations that alter the {@link AttributeSchemaContract()} either in
* {@link CatalogSchemaContract}, {@link EntitySchemaContract} or {@link ReferenceSchemaContract}.
* The implementations can either modify the entire owner schema or partially only a single
* {@link AttributeSchemaContract} of it.
*
* @author Jan Novotný ([email protected]), FG Forrest a.s. (c) 2022
*/
@Immutable
@ThreadSafe
public interface AttributeSchemaMutation extends SchemaMutation {
/**
* Returns the name of the attribute.
*/
@Nonnull
String getName();
/**
* Method applies the mutation operation on the attribute schema in the input and returns modified version
* as its return value. The create operation works with NULL input value and produces non-NULL result, the remove
* operation produces the opposite. Modification operations always accept and produce non-NULL values.
*
* @param catalogSchema owner catalog schema that contains shared global {@link CatalogSchemaContract#getAttributes()}
* @param attributeSchema current version of the schema as an input to mutate
*/
@Nullable
S mutate(@Nullable CatalogSchemaContract catalogSchema, @Nullable S attributeSchema, @Nonnull Class schemaType);
}