View Javadoc
1   /**
2    * Portions of this software was developed by employees of the National Institute
3    * of Standards and Technology (NIST), an agency of the Federal Government and is
4    * being made available as a public service. Pursuant to title 17 United States
5    * Code Section 105, works of NIST employees are not subject to copyright
6    * protection in the United States. This software may be subject to foreign
7    * copyright. Permission in the United States and in foreign countries, to the
8    * extent that NIST may hold copyright, to use, copy, modify, create derivative
9    * works, and distribute this software and its documentation without fee is hereby
10   * granted on a non-exclusive basis, provided that this notice and disclaimer
11   * of warranty appears in all copies.
12   *
13   * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14   * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15   * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17   * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18   * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
19   * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20   * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21   * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22   * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23   * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24   * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25   */
26  
27  package gov.nist.secauto.decima.xml.testing;
28  
29  import org.junit.runner.Describable;
30  import org.junit.runner.Description;
31  
32  import java.io.Serializable;
33  
34  public abstract class DescriptionAdapter<T> implements Describable {
35    private static int uniqueId = 0;
36  
37    protected synchronized String getNextUniqueId() {
38      StringBuilder builder = new StringBuilder();
39      builder.append(getClass().getCanonicalName());
40      builder.append("-");
41      builder.append(uniqueId++);
42      return builder.toString();
43    }
44  
45    private final T delegate;
46    private Description description;
47  
48    public DescriptionAdapter(T delegate) {
49      this.delegate = delegate;
50    }
51  
52    public T getDelegate() {
53      return delegate;
54    }
55  
56    /**
57     * Provides a JUnit {@link Description} instance based on information from the delegate class
58     * instance.
59     * 
60     * {@inheritDoc}
61     */
62    @Override
63    public Description getDescription() {
64      if (description == null) {
65        description = createDescription();
66      }
67      return description;
68    }
69  
70    protected abstract String getName();
71  
72    protected Description createDescription() {
73      String name = getName();
74      return Description.createTestDescription(getDelegate().getClass().getCanonicalName(), name,
75          (Serializable) getNextUniqueId());
76    }
77  }