001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.chain.impl;
018
019import org.apache.commons.chain.Chain;
020import org.apache.commons.chain.Command;
021import org.apache.commons.chain.Context;
022
023/**
024 * Implementation of {@link Command} that logs its identifier and
025 * and delegates to the rest of the chain.
026 *
027 * @author Craig R. McClanahan
028 * @version $Revision$ $Date$
029 */
030public class DelegatingCommand extends NonDelegatingCommand {
031
032    // ------------------------------------------------------------ Constructor
033
034    public DelegatingCommand() {
035        this("");
036    }
037
038    /**
039     * Construct an instance that will log the specified identifier
040     *
041     * @param id identifier to log for this Command instance
042     */
043    public DelegatingCommand(String id) {
044        super(id);
045    }
046
047    // -------------------------------------------------------- Command Methods
048
049    /**
050     * Execution method for this Command
051     *
052     * @param context The {@link Context} to be processed by this
053     *        {@link Command}
054     *
055     * @return {@code true} if the processing of this {@link Context}
056     *         has been completed, or {@code false} if the processing
057     *         of this {@link Context} should be delegated to a
058     *         subsequent {@link Command} in an enclosing {@link Chain}
059     *
060     * @throws Exception general purpose exception return
061     *         to indicate abnormal termination
062     * @throws IllegalArgumentException if {@code context}
063     *         is {@code null}
064     */
065    @Override
066    public boolean execute(Context context) throws Exception {
067        super.execute(context);
068        return false;
069    }
070}