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  */
  17 public interface CheckedBuilder<P, E extends Exception> extends Mutable {
  18     /**
  19      * Returns instance of the product. Multiple calls to this method are not required to return same instance if
  20      * the state of the builder has changed.
  21      *
  22      * @return A newly-built instance
  23      * @throws E if the builder's state is not sufficiently initialized
  24      */
  25     @NonNull P build() throws E;
  26 }