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

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. 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 javax.annotation.Nonnull;
  13
  14 /**
  15  * Utility registration handle. It is a convenience for register-style method
  16  * which can return an AutoCloseable realized by a subclass of this class.
  17  * Invoking the close() method triggers unregistration of the state the method
  18  * installed.
  19  */
  20 public abstract class AbstractObjectRegistration<T> extends AbstractRegistration implements ObjectRegistration<T> {
  21     private final T instance;
  22
  23     protected AbstractObjectRegistration(final @Nonnull T instance) {
  24         this.instance = requireNonNull(instance);
  25     }
  26
  27     @Override
  28     public final T getInstance() {
  29         return instance;
  30     }
  31
  32     @Override
  33     public String toString() {
  34         return "AbstractObjectRegistration{instance=" + instance + '}';
  35     }
  36 }
  37