001: /*
002: * ====================================================================
003: * JAFFA - Java Application Framework For All
004: *
005: * Copyright (C) 2002 JAFFA Development Group
006: *
007: * This library is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU Lesser General Public
009: * License as published by the Free Software Foundation; either
010: * version 2.1 of the License, or (at your option) any later version.
011: *
012: * This library is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this library; if not, write to the Free Software
019: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020: *
021: * Redistribution and use of this software and associated documentation ("Software"),
022: * with or without modification, are permitted provided that the following conditions are met:
023: * 1. Redistributions of source code must retain copyright statements and notices.
024: * Redistributions must also contain a copy of this document.
025: * 2. Redistributions in binary form must reproduce the above copyright notice,
026: * this list of conditions and the following disclaimer in the documentation
027: * and/or other materials provided with the distribution.
028: * 3. The name "JAFFA" must not be used to endorse or promote products derived from
029: * this Software without prior written permission. For written permission,
030: * please contact mail to: jaffagroup@yahoo.com.
031: * 4. Products derived from this Software may not be called "JAFFA" nor may "JAFFA"
032: * appear in their names without prior written permission.
033: * 5. Due credit should be given to the JAFFA Project (http://jaffa.sourceforge.net).
034: *
035: * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
036: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
037: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
038: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
039: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
040: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
041: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
042: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
043: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
044: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
045: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
046: * SUCH DAMAGE.
047: * ====================================================================
048: */
049:
050: package org.jaffa.components.codehelper.dto;
051:
052: import java.util.*;
053:
054: /** The output of the ICodeHelper, will consist of a List of instances of this class.
055: * An instance will be created corresponding to each domainClassName passed in the input.
056: *
057: * @author GautamJ
058: */
059: public class CodeHelperOutElementDto {
060:
061: /** Holds value of property code. */
062: private String code;
063:
064: /** Holds value of property domainClassName. */
065: private String domainClassName;
066:
067: /** Holds value of property codeHelperOutCodeDtos. */
068: private List codeHelperOutCodeDtos;
069:
070: /** Creates new CodeHelperInElementDto */
071: public CodeHelperOutElementDto() {
072: }
073:
074: /** Getter for property code.
075: * @return Value of property code.
076: */
077: public String getCode() {
078: return code;
079: }
080:
081: /** Setter for property code.
082: * @param code New value of property code.
083: */
084: public void setCode(String code) {
085: this .code = code;
086: }
087:
088: /** Getter for property domainClassName.
089: * @return Value of property domainClassName.
090: */
091: public String getDomainClassName() {
092: return domainClassName;
093: }
094:
095: /** Setter for property domainClassName.
096: * @param domainClassName New value of property domainClassName.
097: */
098: public void setDomainClassName(String domainClassName) {
099: this .domainClassName = domainClassName;
100: }
101:
102: /** Add a codeHelperOutCodeDto to the list
103: * @param codeHelperOutCodeDto A codeHelperOutCodeDto
104: */
105: public void addCodeHelperOutCodeDto(
106: CodeHelperOutCodeDto codeHelperOutCodeDto) {
107: if (codeHelperOutCodeDtos == null)
108: codeHelperOutCodeDtos = new ArrayList();
109: codeHelperOutCodeDtos.add(codeHelperOutCodeDto);
110: }
111:
112: /** Add a codeHelperOutCodeDto at the specified position in the list
113: * @param codeHelperOutCodeDto A codeHelperOutCodeDto
114: * @param index The position in the list
115: */
116: public void setCodeHelperOutCodeDto(
117: CodeHelperOutCodeDto codeHelperOutCodeDto, int index) {
118: if (codeHelperOutCodeDtos == null)
119: codeHelperOutCodeDtos = new ArrayList();
120:
121: //-- check bounds for index
122: if (index < 0 || index > codeHelperOutCodeDtos.size())
123: throw new IndexOutOfBoundsException();
124:
125: codeHelperOutCodeDtos.set(index, codeHelperOutCodeDto);
126: }
127:
128: /** Recreate the internal list with the input array of codeHelperOutCodeDto
129: * @param codeHelperOutCodeDtos An array of codeHelperOutCodeDto
130: */
131: public void setCodeHelperOutCodeDtos(
132: CodeHelperOutCodeDto[] codeHelperOutCodeDtos) {
133: this .codeHelperOutCodeDtos = Arrays
134: .asList(codeHelperOutCodeDtos);
135: }
136:
137: /** Clear the list of codeHelperOutCodeDto
138: */
139: public void clearCodeHelperOutCodeDtos() {
140: if (codeHelperOutCodeDtos != null)
141: codeHelperOutCodeDtos.clear();
142: }
143:
144: /** Remove a codeHelperOutCodeDto from the list
145: * @param codeHelperOutCodeDto The codeHelperOutCodeDto to be removed
146: * @return true if this list contained the specified element
147: */
148: public boolean removeCodeHelperOutCodeDto(
149: CodeHelperOutCodeDto codeHelperOutCodeDto) {
150: if (codeHelperOutCodeDtos != null)
151: return codeHelperOutCodeDtos.remove(codeHelperOutCodeDto);
152: else
153: return false;
154: }
155:
156: /** Return a codeHelperOutCodeDto at the specified position in the list
157: * @param index The position in the list
158: * @return The codeHelperOutCodeDto
159: */
160: public CodeHelperOutCodeDto getCodeHelperOutCodeDto(int index) {
161: //-- check bounds for index
162: if (codeHelperOutCodeDtos == null || index < 0
163: || index > codeHelperOutCodeDtos.size())
164: throw new IndexOutOfBoundsException();
165:
166: return (CodeHelperOutCodeDto) codeHelperOutCodeDtos.get(index);
167: }
168:
169: /** Returns an array of codeHelperOutCodeDto
170: * @return An array of codeHelperOutCodeDto
171: */
172: public CodeHelperOutCodeDto[] getCodeHelperOutCodeDtos() {
173: if (codeHelperOutCodeDtos != null)
174: return (CodeHelperOutCodeDto[]) codeHelperOutCodeDtos
175: .toArray(new CodeHelperOutCodeDto[0]);
176: else
177: return null;
178: }
179:
180: /** Returns the number of codeHelperOutCodeDto in the list
181: * @return The number of codeHelperOutCodeDto in the list
182: */
183: public int getCodeHelperOutCodeDtoCount() {
184: if (codeHelperOutCodeDtos != null)
185: return codeHelperOutCodeDtos.size();
186: else
187: return 0;
188: }
189:
190: /** Returns diagnostic information.
191: * @return diagnostic information.
192: */
193: public String toString() {
194: StringBuffer buf = new StringBuffer();
195: buf.append("<CodeHelperOutElementDto>");
196: buf.append("<code>");
197: if (code != null)
198: buf.append(code);
199: buf.append("</code>");
200: buf.append("<domainClassName>");
201: if (domainClassName != null)
202: buf.append(domainClassName);
203: buf.append("</domainClassName>");
204:
205: buf.append("<codeHelperOutCodeDtos>");
206: if (codeHelperOutCodeDtos != null) {
207: for (Iterator i = codeHelperOutCodeDtos.iterator(); i
208: .hasNext();)
209: buf.append(i.next());
210: }
211: buf.append("</codeHelperOutCodeDtos>");
212:
213: buf.append("</CodeHelperOutElementDto>");
214: return buf.toString();
215: }
216:
217: }
|