001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *  http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    
020    package org.apache.geronimo.gshell.clp.handler;
021    
022    import org.apache.geronimo.gshell.clp.Descriptor;
023    import org.apache.geronimo.gshell.clp.ProcessingException;
024    import org.apache.geronimo.gshell.clp.StopProcessingOptionsNotification;
025    import org.apache.geronimo.gshell.clp.setter.Setter;
026    
027    /**
028     * Handler to abort further option processing (and soak up remaining tokens as arguments).
029     *
030     * @version $Rev: 570606 $ $Date: 2007-08-28 19:17:11 -0700 (Tue, 28 Aug 2007) $
031     */
032    public class StopHandler
033        extends Handler<String>
034    {
035        public StopHandler(Descriptor desc, Setter<? super String> setter) {
036            super(desc, setter);
037        }
038    
039        @Override
040        public int handle(final Parameters params) throws ProcessingException {
041            throw new StopProcessingOptionsNotification();
042        }
043    
044        @Override
045        public String getDefaultMetaVariable() {
046            return "ARGUMENTS";
047        }
048    }