[prev in list] [next in list] [prev in thread] [next in thread] 

List:       jakarta-commons-dev
Subject:    cvs commit: jakarta-commons/betwixt/src/java/org/apache/commons/betwixt BindingConfiguration.java
From:       rdonkin () apache ! org
Date:       2003-07-31 21:35:42
[Download RAW message or body]

rdonkin     2003/07/31 14:35:42

  Added:       betwixt/src/java/org/apache/commons/betwixt
                        BindingConfiguration.java
  Log:
  BindingConfiguration is a single object where all dynamic binding (as opposed to \
introspection time) configuration settings can be stored. Only settings shared \
between the reader and the writer should be included in this class  
  Revision  Changes    Path
  1.1                  \
jakarta-commons/betwixt/src/java/org/apache/commons/betwixt/BindingConfiguration.java \
  Index: BindingConfiguration.java
  ===================================================================
  /*
   * $Header: /home/cvs/jakarta-commons/betwixt/src/java/org/apache/commons/betwixt/BindingConfiguration.java,v \
                1.1 2003/07/31 21:35:42 rdonkin Exp $
   * $Revision: 1.1 $
   * $Date: 2003/07/31 21:35:42 $
   *
   * ====================================================================
   *
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Commons", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   * 
   * $Id: BindingConfiguration.java,v 1.1 2003/07/31 21:35:42 rdonkin Exp $
   */
  package org.apache.commons.betwixt;
  
  import java.io.Serializable;
  
  import org.apache.commons.betwixt.strategy.ObjectStringConverter;
  import org.apache.commons.betwixt.strategy.DefaultObjectStringConverter;
  
  /** <p>Stores mapping phase binding configuration.</p>
    *
    * <p>There are two phase in Betwixt's processing.
    * The first phase is the introspection of the bean.
    * Strutural configuration settings effect this phase.
    * The second phase comes when Betwixt dynamically uses
    * reflection to execute the mapping.
    * This object stores configuration settings pertaining 
    * to the second phase.</p>
    *
    * <p>These common settings have been collected into one class
    * to make round tripping easier since the same <code>BindingConfiguration</code>
    * can be shared.</p> 
    *
    * @author <a href="mailto:rdonkin@apache.org">Robert Burrell Donkin</a>
    * @version $Revision: 1.1 $
    */
  public class BindingConfiguration implements Serializable {
  
      /** Should <code>ID</code>'s and <code>IDREF</code> be used cross-reference \
matching objects? */  private boolean mapIDs = true;
      /** Converts objects &lt-&gt; strings */
      private ObjectStringConverter objectStringConverter;
      
      /**
       * Constructs a BindingConfiguration with default properties.
       */
      public BindingConfiguration() {
          this(new DefaultObjectStringConverter(), true);
      }
      
      /** 
       * Constructs a BindingConfiguration
       * @param objectStringConverter the <code>ObjectStringConverter</code>
       * to be used to convert Objects &lt;-&gt; Strings
       * @param mapIDs should <code>ID</code>'s and <code>IDREF</code> be used to \
                cross-reference
       */ 
      public BindingConfiguration(ObjectStringConverter objectStringConverter, \
boolean mapIDs) {  setObjectStringConverter(objectStringConverter);
          setMapIDs(mapIDs);
      }
      
      /**
        * Gets the Object &lt;-&gt; String converter.
        * @return the ObjectStringConverter to use, not null
        */
      public ObjectStringConverter getObjectStringConverter() {
          return objectStringConverter;
      }
      
      /**
        * Sets the Object &lt;-&gt; String converter.
        * @param the ObjectStringConverter to be used, not null
        */
      public void setObjectStringConverter(ObjectStringConverter \
objectStringConverter) {  this.objectStringConverter = objectStringConverter;
      }	
      
      /** 
       * Should <code>ID</code>'s and <code>IDREF</code> attributes 
       * be used to cross-reference matching objects? 
       *
       * @return true if <code>ID</code> and <code>IDREF</code> 
       * attributes should be used to cross-reference instances
       */
      public boolean getMapIDs() {
          return mapIDs;
      }
      
      /**
       *Should <code>ID</code>'s and <code>IDREF</code> attributes 
       * be used to cross-reference matching objects? 
       *
       * @param mapIDs pass true if <code>ID</code>'s should be used to \
                cross-reference
       */
      public void setMapIDs(boolean mapIDs) {
          this.mapIDs = mapIDs;
      }        
  }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


[prev in list] [next in list] [prev in thread] [next in thread] 

Configure | About | News | Add a list | Sponsored by KoreLogic