/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.faces.config.rules;
import org.xml.sax.Attributes;
import com.sun.faces.config.beans.MapEntriesBean;
import com.sun.faces.config.beans.MapEntriesHolder;
import com.sun.faces.config.beans.MapEntryBean;
import org.apache.commons.digester.Rule;
/**
* <p>Digester rule for the <code><map-entries></code> element.</p>
*/
public class MapEntriesRule extends Rule {
private static final String CLASS_NAME =
"com.sun.faces.config.beans.MapEntriesBean";
// ------------------------------------------------------------ Rule Methods
/**
* <p>Create an empty instance of <code>MapEntriesBean</code>
* and push it on to the object stack.</p>
*
* @param namespace the namespace URI of the matching element, or an
* empty string if the parser is not namespace aware or the element has
* no namespace
* @param name the local name if the parser is namespace aware, or just
* the element name otherwise
* @param attributes The attribute map of this element
*
* @exception IllegalStateException if the parent stack element is not
* of type MapEntriesHolder
*/
public void begin(String namespace, String name,
Attributes attributes) throws Exception {
assert digester.peek() instanceof MapEntriesHolder
: "Assertion Error: Expected MapEntriesHolder to be at the top of the stack";
if (digester.getLogger().isDebugEnabled()) {
digester.getLogger().debug("[MapEntriesRule]{" +
digester.getMatch() +
"} Push " + CLASS_NAME);
}
Class clazz =
digester.getClassLoader().loadClass(CLASS_NAME);
MapEntriesBean meb = (MapEntriesBean) clazz.newInstance();
digester.push(meb);
}
/**
* <p>No body processing is requlred.</p>
*
* @param namespace the namespace URI of the matching element, or an
* empty string if the parser is not namespace aware or the element has
* no namespace
* @param name the local name if the parser is namespace aware, or just
* the element name otherwise
* @param text The text of the body of this element
*/
public void body(String namespace, String name,
String text) throws Exception {
}
/**
* <p>Pop the <code>MapEntriesBean</code> off the top of the stack,
* and either add or merge it with previous information.</p>
*
* @param namespace the namespace URI of the matching element, or an
* empty string if the parser is not namespace aware or the element has
* no namespace
* @param name the local name if the parser is namespace aware, or just
* the element name otherwise
*
* @exception IllegalStateException if the popped object is not
* of the correct type
*/
public void end(String namespace, String name) throws Exception {
MapEntriesBean top = null;
try {
top = (MapEntriesBean) digester.pop();
} catch (Exception e) {
throw new IllegalStateException("Popped object is not a " +
CLASS_NAME + " instance");
}
MapEntriesHolder meh = (MapEntriesHolder) digester.peek();
MapEntriesBean old = meh.getMapEntries();
if (old == null) {
if (digester.getLogger().isDebugEnabled()) {
digester.getLogger().debug("[MapEntriesRule]{" +
digester.getMatch() +
"} New");
}
meh.setMapEntries(top);
} else {
if (digester.getLogger().isDebugEnabled()) {
digester.getLogger().debug("[ManagedBeanRule]{" +
digester.getMatch() +
"} Merge");
}
mergeMapEntries(top, old);
}
}
/**
* <p>No finish processing is required.</p>
*
*/
public void finish() throws Exception {
}
// ---------------------------------------------------------- Public Methods
public String toString() {
StringBuffer sb = new StringBuffer("MapEntriesRule[className=");
sb.append(CLASS_NAME);
sb.append("]");
return (sb.toString());
}
// --------------------------------------------------------- Package Methods
// Merge "top" into "old"
static void mergeMapEntries(MapEntriesBean top, MapEntriesBean old) {
// Merge singleton properties
if (top.getKeyClass() != null) {
old.setKeyClass(top.getKeyClass());
}
if (top.getValueClass() != null) {
old.setValueClass(top.getValueClass());
}
// Merge common collections
// Merge unique collections
MapEntryBean mapEntries[] = top.getMapEntries();
for (int i = 0; i < mapEntries.length; i++) {
old.addMapEntry(mapEntries[i]);
}
}
// Merge "top" into "old"
static void mergeMapEntries(MapEntriesHolder top, MapEntriesHolder old) {
MapEntriesBean mebt = top.getMapEntries();
if (mebt != null) {
MapEntriesBean mebo = old.getMapEntries();
if (mebo != null) {
mergeMapEntries(mebt, mebo);
} else {
old.setMapEntries(mebt);
}
}
}
}