001/**
002 * TextGuard.java
003 * 
004 * Copyright (c) 2004-2012, Nicole C. Tedesco. All rights reserved.
005 * 
006 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
007 * use this file except in compliance with the License. You may obtain a copy of
008 * 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, software
013 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
014 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
015 * License for the specific language governing permissions and limitations under
016 * the License.
017 */
018
019package net.sf.jaccumulator.lex;
020
021import javax.swing.text.TextAction;
022
023import net.sf.jaccumulator.texts.SealedText;
024
025/**
026 * Determines whether a {@link TextAction} signal should be rejected or accepted
027 * within the current context of a specific model
028 * 
029 * @param <MODEL>
030 *        the model type to test against
031 * 
032 * @since JAccumulator 4.0
033 * @author Nicole Tedesco (<a
034 *         href="mailto:nicole@tedesco.name">nicole@tedesco.name</a>)
035 */
036public interface TextGuard<MODEL>
037    extends
038        Guard<MODEL>
039{
040    public boolean acceptText( final CharSequence aSignal, final MODEL aModel );
041
042    public boolean acceptText( final SealedText<?> aSignal, final MODEL aModel );
043
044    public boolean acceptText( final String aSignal, final MODEL aModel );
045
046    public TextGuard<MODEL> getTextGuardAt( final int anIndex )
047        throws IndexOutOfBoundsException;
048
049    public int getTextGuardChildCount();
050}