common/src/main/java/org/apache/cassandra/sidecar/common/DataObjectBuilder.java

/*
 * 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 org.apache.cassandra.sidecar.common;

import java.util.function.Consumer;

/**
 * Interface to build data objects
 *
 * @param <T> type of builder
 * @param <R> type of result from build
 */
public interface DataObjectBuilder<T extends DataObjectBuilder<?, ?>, R>
{
    /**
     * Self typing
     *
     * @return type of implementor class
     */
    T self();

    /**
     * Build into data object of type R
     *
     * @return data object type
     */
    R build();

    /**
     * Updates a field in the builder
     *
     * @param updater function to mutate fields
     * @return builder itself for chained invocation
     */
    default T update(Consumer<? super T> updater)
    {
        updater.accept(self());
        return self();
    }
}