third-party/atomix/utils/src/main/java/io/atomix/utils/Builder.java

   1 /*
   2  * Copyright 2017-present Open Networking Foundation
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package io.atomix.utils;
  17
  18 /**
  19  * Object builder.
  20  * <p>
  21  * This is a base interface for building objects in Catalyst.
  22  *
  23  * @param <T> type to build
  24  */
  25 public interface Builder<T> {
  26
  27   /**
  28    * Builds the object.
  29    * <p>
  30    * The returned object may be a new instance of the built class or a recycled instance, depending on the semantics
  31    * of the builder implementation. Users should never assume that a builder allocates a new instance.
  32    *
  33    * @return The built object.
  34    */
  35   T build();
  36
  37 }