Document Delegator and AbstractDelegator
[yangtools.git] / common / concepts / src / main / java / org / opendaylight / yangtools / concepts / AbstractDelegator.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 org.eclipse.jdt.annotation.NonNullByDefault;
14
15 /**
16  * Simple base class for classes which wish to implement {@link Delegator} interface and are not otherwise constrained
17  * in their class hierarchy.
18  *
19  * @param <T> Type of delegate
20  */
21 @Beta
22 @NonNullByDefault
23 public abstract class AbstractDelegator<T> implements Delegator<T> {
24     private final T delegate;
25
26     protected AbstractDelegator(final T delegate) {
27         this.delegate = requireNonNull(delegate);
28     }
29
30     @Override
31     public final T getDelegate() {
32         return delegate;
33     }
34 }