Add AbstractDelegator.toString()
[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 com.google.common.base.MoreObjects;
14 import com.google.common.base.MoreObjects.ToStringHelper;
15 import org.eclipse.jdt.annotation.NonNullByDefault;
16
17 /**
18  * Simple base class for classes which wish to implement {@link Delegator} interface and are not otherwise constrained
19  * in their class hierarchy.
20  *
21  * @param <T> Type of delegate
22  */
23 @Beta
24 @NonNullByDefault
25 public abstract class AbstractDelegator<T> implements Delegator<T> {
26     private final T delegate;
27
28     protected AbstractDelegator(final T delegate) {
29         this.delegate = requireNonNull(delegate);
30     }
31
32     @Override
33     public final T getDelegate() {
34         return delegate;
35     }
36
37     @Override
38     public final String toString() {
39         return addToString(MoreObjects.toStringHelper(this).omitNullValues()).toString();
40     }
41
42     protected ToStringHelper addToString(final ToStringHelper helper) {
43         return helper.add("delegate", delegate);
44     }
45 }