001 /* ====================================================================
002 * The Apache Software License, Version 1.1
003 *
004 * Copyright (c) 2003 The Apache Software Foundation. All rights
005 * reserved.
006 *
007 * Redistribution and use in source and binary forms, with or without
008 * modification, are permitted provided that the following conditions
009 * are met:
010 *
011 * 1. Redistributions of source code must retain the above copyright
012 * notice, this list of conditions and the following disclaimer.
013 *
014 * 2. Redistributions in binary form must reproduce the above copyright
015 * notice, this list of conditions and the following disclaimer in
016 * the documentation and/or other materials provided with the
017 * distribution.
018 *
019 * 3. The end-user documentation included with the redistribution,
020 * if any, must include the following acknowledgment:
021 * "This product includes software developed by the
022 * Apache Software Foundation (http://www.apache.org/)."
023 * Alternately, this acknowledgment may appear in the software itself,
024 * if and wherever such third-party acknowledgments normally appear.
025 *
026 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
027 * Foundation" must not be used to endorse or promote products derived
028 * from this software without prior written permission. For written
029 * permission, please contact apache@apache.org.
030 *
031 * 5. Products derived from this software may not be called "Apache",
032 * nor may "Apache" appear in their name, without prior written
033 * permission of the Apache Software Foundation.
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 * This software consists of voluntary contributions made by many
050 * individuals on behalf of the Apache Software Foundation. For more
051 * information on the Apache Software Foundation, please see
052 * <http://www.apache.org/>.
053 *
054 */
055 package org.jpu.patterns.factory;
056
057 import java.util.Arrays;
058
059 /**
060 * Used by clients of {@link IPrototypeFactory} to pass options adjusting
061 * its behavior.
062 */
063 public class FactoryOptions implements Cloneable {
064 public Object clone() {
065 try {
066 return super.clone();
067 }
068 catch( CloneNotSupportedException e ) {
069 throw new PrototypeFactoryRuntimeException(e);
070 }
071 }
072 public static FactoryOptions makeNew(FactoryOptions o) {
073 return (o == null) ? new FactoryOptions() : (FactoryOptions)o.clone();
074 }
075 public static FactoryOptions defaultIfNull(FactoryOptions o) {
076 if ( o == null ) {
077 o = new FactoryOptions();
078 }
079 return o;
080 }
081 public FactoryOptions setCopy(boolean b) {
082 copy = b;
083 return this;
084 }
085 public boolean getCopy() {
086 return copy;
087 }
088
089 /**
090 * Sets the 'throwExc' attribute to the given value. This
091 * attribute specifies whether or not a {@link NoSuchPrototypeException}
092 * should be thrown if a prototype is requested by a key under which no
093 * prototype has been registered. If this attribute is <code>false</code>,
094 * the method called to request the object will return <code>null</code>
095 * instead of throwing an exception.
096 * <p>
097 * 'throwExc' is <code>true</code> by default.
098 */
099 public FactoryOptions setThrowExc(boolean b) {
100 throwExc = b;
101 return this;
102 }
103
104 /**
105 * Returns the 'throwExc' attribute. See {@link #setThrowExc}.
106 */
107 public boolean getThrowExc() {
108 return throwExc;
109 }
110
111 /**
112 * Sets the 'userData' attribute to the given value. User data is an array of
113 * <code>Object</code>'s used to parameterize instantiations done by
114 * the factory. These parameters are ignored by the classes in
115 * {@link org.jpu.patterns.factory} but may be referenced either
116 * by strategies registered with the factory by clients, or by
117 * subclasses that override method accepting a {@link FactoryOptions}
118 * parameter.
119 * <p>
120 * Typically, 'userData' would be used in conjunction with
121 * {@link IPrototypeFactory.IInstantiator}'s for prototype classes
122 * whose constructors require one or more parameters.
123 * <p>
124 * 'userData' is <code>null</code> by default.
125 */
126 public FactoryOptions setUserData(Object[] m) {
127 userdata = m;
128 return this;
129 }
130
131 /**
132 * Returns the 'userData' attribute. See {@link #setUserData}.
133 */
134 public Object[] getUserData() {
135 return userdata;
136 }
137 public String toString() {
138 return "copy=" + copy + ", throwExc=" + throwExc;
139 }
140 public boolean copy = true;
141 public boolean throwExc = true;
142 public Object[] userdata = null;
143 }
144
145
146
147