io.streamthoughts.kafka.specs.Description Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jikkou Show documentation

A command-line tool to help you automate the management of the configurations that live on your Apache Kafka clusters.

There is a newer version: 0.30.0

/*
 * Copyright 2020 StreamThoughts.
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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.streamthoughts.kafka.specs;

import io.streamthoughts.kafka.specs.change.Change;

/**
 * Simple interface to get a human-readable description of an executed operation.
 */
public interface Description {

    enum OperationType { CREATE, ALTER, DELETE, NONE }

    /**
     * @return the type of the operation.
     */
    OperationType operation();

    /**
     * @return a textual description of the operation.
     */
    String textDescription();

    interface Create extends Description {

        /**
         * @return {@link Change.OperationType#ADD}.
         */
        @Override
        default OperationType operation() {
            return OperationType.CREATE;
        }
    }

    interface Alter extends Description {

        /**
         * @return {@link Change.OperationType#UPDATE}.
         */
        @Override
        default OperationType operation() {
            return OperationType.ALTER;
        }
    }

    interface Delete extends Description {

        /**
         * @return {@link Change.OperationType#DELETE}.
         */
        @Override
        default OperationType operation() {
            return OperationType.DELETE;
        }
    }

    interface None extends Description {

        /**
         * @return {@link Change.OperationType#NONE}.
         */
        @Override
        default OperationType operation() {
            return OperationType.NONE;
        }
    }
}