View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.pool2;
18  
19  /**
20   * A base class for common functionality.
21   *
22   * @since 2.4.3
23   */
24  public abstract class BaseObject {
25  
26      @Override
27      public String toString() {
28          final StringBuilder builder = new StringBuilder();
29          builder.append(getClass().getSimpleName());
30          builder.append(" [");
31          toStringAppendFields(builder);
32          builder.append("]");
33          return builder.toString();
34      }
35  
36      /**
37       * Used by sub-classes to include the fields defined by the sub-class in the
38       * {@link #toString()} output.
39       *
40       * @param builder Field names and values are appended to this object
41       */
42      protected void toStringAppendFields(final StringBuilder builder) {
43          // do nothing by default, needed for b/w compatibility.
44      }
45  }