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 is the output of the ICodeHelper. It will contain zero or more CodeHelperOutElementDto objects, corresponding to the number of domainClassName values passed in the input.
055: * In turn, each CodeHelperOutElementDto may contain zero or more CodeHelperOutCodeDto objects.
056: *
057: * @author GautamJ
058: */
059: public class CodeHelperOutDto {
060:
061: /** Holds value of property codeHelperOutElementDtos. */
062: private List codeHelperOutElementDtos;
063:
064: /** Creates new CodeHelperOutElementDto */
065: public CodeHelperOutDto() {
066: }
067:
068: /** Add a codeHelperOutElementDto to the list
069: * @param codeHelperOutElementDto A codeHelperOutElementDto
070: */
071: public void addCodeHelperOutElementDto(
072: CodeHelperOutElementDto codeHelperOutElementDto) {
073: if (codeHelperOutElementDtos == null)
074: codeHelperOutElementDtos = new ArrayList();
075: codeHelperOutElementDtos.add(codeHelperOutElementDto);
076: }
077:
078: /** Add a codeHelperOutElementDto at the specified position in the list
079: * @param codeHelperOutElementDto A codeHelperOutElementDto
080: * @param index The position in the list
081: */
082: public void setCodeHelperOutElementDto(
083: CodeHelperOutElementDto codeHelperOutElementDto, int index) {
084: if (codeHelperOutElementDtos == null)
085: codeHelperOutElementDtos = new ArrayList();
086:
087: //-- check bounds for index
088: if (index < 0 || index > codeHelperOutElementDtos.size())
089: throw new IndexOutOfBoundsException();
090:
091: codeHelperOutElementDtos.set(index, codeHelperOutElementDto);
092: }
093:
094: /** Recreate the internal list with the input array of codeHelperOutElementDto
095: * @param codeHelperOutElementDtos An array of codeHelperOutElementDto
096: */
097: public void setCodeHelperOutElementDtos(
098: CodeHelperOutElementDto[] codeHelperOutElementDtos) {
099: this .codeHelperOutElementDtos = Arrays
100: .asList(codeHelperOutElementDtos);
101: }
102:
103: /** Clear the list of codeHelperOutElementDto
104: */
105: public void clearCodeHelperOutElementDtos() {
106: if (codeHelperOutElementDtos != null)
107: codeHelperOutElementDtos.clear();
108: }
109:
110: /** Remove a codeHelperOutElementDto from the list
111: * @param codeHelperOutElementDto The codeHelperOutElementDto to be removed
112: * @return true if this list contained the specified element
113: */
114: public boolean removeCodeHelperOutElementDto(
115: CodeHelperOutElementDto codeHelperOutElementDto) {
116: if (codeHelperOutElementDtos != null)
117: return codeHelperOutElementDtos
118: .remove(codeHelperOutElementDto);
119: else
120: return false;
121: }
122:
123: /** Return a codeHelperOutElementDto at the specified position in the list
124: * @param index The position in the list
125: * @return The codeHelperOutElementDto
126: */
127: public CodeHelperOutElementDto getCodeHelperOutElementDto(int index) {
128: //-- check bounds for index
129: if (codeHelperOutElementDtos == null || index < 0
130: || index > codeHelperOutElementDtos.size())
131: throw new IndexOutOfBoundsException();
132:
133: return (CodeHelperOutElementDto) codeHelperOutElementDtos
134: .get(index);
135: }
136:
137: /** Returns an array of codeHelperOutElementDto
138: * @return An array of codeHelperOutElementDto
139: */
140: public CodeHelperOutElementDto[] getCodeHelperOutElementDtos() {
141: if (codeHelperOutElementDtos != null)
142: return (CodeHelperOutElementDto[]) codeHelperOutElementDtos
143: .toArray(new CodeHelperOutElementDto[0]);
144: else
145: return null;
146: }
147:
148: /** Returns the number of codeHelperOutElementDto in the list
149: * @return The number of codeHelperOutElementDto in the list
150: */
151: public int getCodeHelperOutElementDtoCount() {
152: if (codeHelperOutElementDtos != null)
153: return codeHelperOutElementDtos.size();
154: else
155: return 0;
156: }
157:
158: /** Returns diagnostic information.
159: * @return diagnostic information.
160: */
161: public String toString() {
162: StringBuffer buf = new StringBuffer();
163: buf.append("<CodeHelperOutDto>");
164: buf.append("<codeHelperOutElementDtos>");
165: if (codeHelperOutElementDtos != null) {
166: for (Iterator i = codeHelperOutElementDtos.iterator(); i
167: .hasNext();)
168: buf.append(i.next());
169: }
170: buf.append("</codeHelperOutElementDtos>");
171: buf.append("</CodeHelperOutDto>");
172: return buf.toString();
173: }
174:
175: }
|