01: /*
02: Copyright (c) 2007, Dennis M. Sosnoski
03: All rights reserved.
04:
05: Redistribution and use in source and binary forms, with or without modification,
06: are permitted provided that the following conditions are met:
07:
08: * Redistributions of source code must retain the above copyright notice, this
09: list of conditions and the following disclaimer.
10: * Redistributions in binary form must reproduce the above copyright notice,
11: this list of conditions and the following disclaimer in the documentation
12: and/or other materials provided with the distribution.
13: * Neither the name of JiBX nor the names of its contributors may be used
14: to endorse or promote products derived from this software without specific
15: prior written permission.
16:
17: THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
18: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19: WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20: DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
21: ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23: LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
24: ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25: (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26: SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27: */
28:
29: package org.jibx.binding.generator;
30:
31: import org.jibx.binding.classes.ClassFile;
32: import org.jibx.binding.classes.ClassItem;
33: import org.jibx.binding.model.ClassWrapper;
34: import org.jibx.binding.model.IClassItem;
35:
36: import com.thoughtworks.qdox.model.JavaClass;
37:
38: /**
39: * Wrapper for class with added source information. This wraps the basic class
40: * handling implementation with added support for retrieving information from
41: * source files.
42: *
43: * @author Dennis M. Sosnoski
44: */
45: public class ClassSourceWrapper extends ClassWrapper {
46: /**
47: * Constructor.
48: *
49: * @param loc
50: * @param clas
51: */
52: public ClassSourceWrapper(IClassSourceLocator loc, ClassFile clas) {
53: super (loc, clas);
54: }
55:
56: /**
57: * Build an item wrapper. This override of the base class implementation
58: * always creates a wrapper which will support source operations.
59: *
60: * @param item
61: * @return wrapper
62: */
63: protected IClassItem buildItem(ClassItem item) {
64: return new ClassItemSourceWrapper(this , item);
65: }
66:
67: /* (non-Javadoc)
68: * @see org.jibx.binding.model.IClass#getJavaDoc()
69: */
70: public String getJavaDoc() {
71: IClassSourceLocator loc = (IClassSourceLocator) getLocator();
72: JavaClass jc = loc.getSourceInfo(getClassFile().getName());
73: if (jc != null) {
74: String text = jc.getComment();
75: if (text != null) {
76: text = text.trim();
77: if (text.length() > 0) {
78: return text;
79: }
80: }
81: }
82: return null;
83: }
84: }
|