common/concepts/src/main/java/org/opendaylight/yangtools/concepts/NoOpObjectRegistration.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 static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.base.MoreObjects;
  14 import org.eclipse.jdt.annotation.NonNullByDefault;
  15
  16 /**
  17  * Implementation of {@link ObjectRegistration} which does nothing in its {@link #close()} method.
  18  *
  19  * @param <T> Type of registered object
  20  */
  21 @Beta
  22 @NonNullByDefault
  23 public class NoOpObjectRegistration<T> implements Immutable, ObjectRegistration<T> {
  24     private final T instance;
  25
  26     NoOpObjectRegistration(final T instance) {
  27         this.instance = requireNonNull(instance);
  28     }
  29
  30     public static <T> ObjectRegistration<T> of(final T instance) {
  31         return new NoOpObjectRegistration<>(instance);
  32     }
  33
  34     @Override
  35     public final T getInstance() {
  36         return instance;
  37     }
  38
  39     @Override
  40     public final void close() {
  41         // No-op
  42     }
  43
  44     @Override
  45     public final String toString() {
  46         return MoreObjects.toStringHelper(this).add("instance", instance).toString();
  47     }
  48 }