org.apache.mina.statemachine.event.EventArgumentsInterceptor Maven / Gradle / Ivy

Go to download
/*
 *  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.mina.statemachine.event;

import org.apache.mina.statemachine.StateMachine;

/**
 * Intercepts the {@link Event} arguments before the {@link Event} is passed
 * to the {@link StateMachine} and allows for the arguments to be modified.
 * This is for advanced uses only.
 *
 * @author Apache MINA Project
 */
public interface EventArgumentsInterceptor {

    /**
     * Modifies the specified array of event arguments.
     * 
     * @param arguments the original arguments.
     * @return the new arguments. Should return the original array if no 
     *         modification is needed.
     */
    Object[] modify(Object[] arguments);

}