svn commit: r1065366 - /commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/ObjectParamRule.java

[si...@apache.org]

Author: simonetripodi
Date: Sun Jan 30 20:14:00 2011
New Revision: 1065366

URL: http://svn.apache.org/viewvc?rev=1065366&view=rev
Log:
first checkin of ObjectParamRule class, a simplified and tidy version of the proper one on /trunk

Added:
    commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/ObjectParamRule.java   (with props)

Added: commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/ObjectParamRule.java
URL: http://svn.apache.org/viewvc/commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/ObjectParamRule.java?rev=1065366&view=auto
==============================================================================
--- commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/ObjectParamRule.java (added)
+++ commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/ObjectParamRule.java Sun Jan 30 20:14:00 2011
@@ -0,0 +1,99 @@
+/* $Id$
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.digester3;
+
+import org.xml.sax.Attributes;
+
+/**
+ * <p>Rule implementation that saves a parameter for use by a surrounding
+ * <code>CallMethodRule<code>.</p>
+ *
+ * <p>This parameter may be:
+ * <ul>
+ * <li>an arbitrary Object defined programatically, assigned when the element 
+ *  pattern associated with the Rule is matched. See 
+ * {@link #ObjectParamRule(int paramIndex, Object param)}.
+ * <li>an arbitrary Object defined programatically, assigned if the element 
+ * pattern AND specified attribute name are matched. See 
+ * {@link #ObjectParamRule(int paramIndex, String attributeName, Object param)}.
+ * </ul>
+ * </p>
+ */
+public class ObjectParamRule extends Rule {
+
+    /**
+     * The attribute which we are attempting to match
+     */
+    private final String attributeName;
+
+    /**
+     * The zero-relative index of the parameter we are saving.
+     */
+    private final int paramIndex;
+
+    /**
+     * The parameter we wish to pass to the method call
+     */
+    private final Object param;
+
+    /**
+     * Construct a "call parameter" rule that will save the given Object as
+     * the parameter value, provided that the specified attribute exists.
+     *
+     * @param paramIndex The zero-relative parameter number
+     * @param attributeName The name of the attribute to match
+     * @param param the parameter to pass along
+     */
+    public ObjectParamRule(int paramIndex, String attributeName, Object param) {
+        this.paramIndex = paramIndex;
+        this.attributeName = attributeName;
+        this.param = param;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public void begin(String namespace, String name, Attributes attributes) throws Exception {
+        Object anAttribute = null;
+        Object parameters[] = (Object[]) this.getDigester().peekParams();
+
+        if (this.attributeName != null) {
+            anAttribute = attributes.getValue(attributeName);
+            if (anAttribute != null) {
+                parameters[paramIndex] = param;
+            }
+            // note -- if attributeName != null and anAttribute == null, this rule
+            // will pass null as its parameter!
+        } else{
+            parameters[paramIndex] = param;
+        }
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public String toString() {
+        return String.format("ObjectParamRule[paramIndex=%s, attributeName=%s, param=%s]",
+                this.paramIndex,
+                this.attributeName,
+                this.param);
+    }
+
+}

Propchange: commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/ObjectParamRule.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/ObjectParamRule.java
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL

Propchange: commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/ObjectParamRule.java
------------------------------------------------------------------------------
    svn:mime-type = text/plain