xref: /packages/inputmethods/LatinIME/java/src/com/android/inputmethod/event/Combiner.java

/*
 * Copyright (C) 2013 The Android Open Source Project
 *
 * 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 com.android.inputmethod.event;

/**
 * A generic interface for combiners.
 */
public interface Combiner {
    /**
     * Combine an event with the existing state and return the new event.
     * @param event the event to combine with the existing state.
     * @return the resulting event.
     */
    Event combine(Event event);
}