View Javadoc

1   /*
2    * Copyright 2006-2012 smartics, Kronseder & Reiner GmbH
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package de.smartics.maven.util.report.link.strategy;
17  
18  import de.smartics.maven.util.report.link.AbstractLinkConstructorStrategy;
19  import de.smartics.maven.util.report.link.LinkConstructorStrategyConfig;
20  
21  /**
22   * Constructs a link to a document whose name is constructed from the package
23   * and type and whose member is optionally referenced within the document.
24   */
25  public class FilePathLinkConstructorStrategy extends
26      AbstractLinkConstructorStrategy
27  {
28    // ********************************* Fields *********************************
29  
30    // --- constants ------------------------------------------------------------
31  
32    // --- members --------------------------------------------------------------
33  
34    // ****************************** Initializer *******************************
35  
36    // ****************************** Constructors ******************************
37  
38    /**
39     * Default constructor.
40     *
41     * @param config the configuration of this strategy instance.
42     */
43    public FilePathLinkConstructorStrategy(
44        final LinkConstructorStrategyConfig config)
45    {
46      super(config);
47    }
48  
49    // ****************************** Inner Classes *****************************
50  
51    // ********************************* Methods ********************************
52  
53    // --- init -----------------------------------------------------------------
54  
55    // --- get&set --------------------------------------------------------------
56  
57    // --- business -------------------------------------------------------------
58  
59    /**
60     * {@inheritDoc}
61     *
62     * @see de.smartics.maven.util.report.link.AbstractLinkConstructorStrategy#addPackagePart(java.lang.StringBuilder,
63     *      java.lang.String)
64     */
65    @Override
66    protected void addPackagePart(final StringBuilder buffer,
67        final String packageName)
68    {
69      buffer.append(packageName).append('.');
70    }
71  
72    // --- object basics --------------------------------------------------------
73  
74  }