Groovy example source code file (XmlCommandRegistrar.groovy)

This example Groovy source code file (XmlCommandRegistrar.groovy) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Groovy tags/keywords

class, classloader, classloader, command, created, logger, registering, shell, shell, string, string, url, xmlcommandregistrar, xmlcommandregistrar

The Groovy XmlCommandRegistrar.groovy source code

/*
 * Copyright 2003-2007 the original author or authors.
 *
 * Licensed 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.codehaus.groovy.tools.shell.util

import org.codehaus.groovy.tools.shell.Shell
import org.codehaus.groovy.tools.shell.Command

/**
 * Registers {@link Command} instances from and XML file.
 *
 * @version $Id: XmlCommandRegistrar.groovy 7581 2007-08-23 01:47:47Z user57 $
 * @author <a href="mailto:jason@planet57.com">Jason Dillon
 */
class XmlCommandRegistrar
{
    private final Logger log = Logger.create(this.class)
    
    private final Shell shell
    
    private final ClassLoader classLoader
    
    XmlCommandRegistrar(final Shell shell, final ClassLoader classLoader) {
        assert shell
        assert classLoader
        
        this.shell = shell
        this.classLoader = classLoader
    }
    
    void register(final URL url) {
        assert url
        
        if (log.debugEnabled) {
            log.debug("Registering commands from: $url")
        }
        
        url.withReader { reader ->
            def doc = new XmlParser().parse(reader)
            
            doc.command.each { element ->
                String classname = element.text()
                
                Class type = classLoader.loadClass(classname)
                
                Command command = type.newInstance(shell)
                
                if (log.debugEnabled) {
                    log.debug("Created command '${command.name}': $command")
                }
                
                shell << command
            }
        }
    }
}