common/concepts/src/main/java/org/opendaylight/yangtools/concepts/CheckedBuilder.java

   1 /*
   2  * Copyright (c) 2018 Pantheon Technologies, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.concepts;
   9
  10 import org.eclipse.jdt.annotation.NonNull;
  11
  12 /**
  13  * Builder object which produces a product.
  14  *
  15  * @param <P> Product of builder
  16  * @deprecated This is an over-arching concept whose {@link #build()} method hides caller hierarchy. Users are advised
  17  *             to migrate away, either without a replacement interface, or with a proper domain-specific interface.
  18  */
  19 @Deprecated(since = "8.0.0", forRemoval = true)
  20 public interface CheckedBuilder<P, E extends Exception> extends Mutable {
  21     /**
  22      * Returns instance of the product. Multiple calls to this method are not required to return same instance if
  23      * the state of the builder has changed.
  24      *
  25      * @return A newly-built instance
  26      * @throws E if the builder's state is not sufficiently initialized
  27      */
  28     @NonNull P build() throws E;
  29 }