1fba2635c088b01af59300e8a02611bb788ee3bffchrismair/* 2fba2635c088b01af59300e8a02611bb788ee3bffchrismair * Copyright 2007 the original author or authors. 3fba2635c088b01af59300e8a02611bb788ee3bffchrismair * 4fba2635c088b01af59300e8a02611bb788ee3bffchrismair * Licensed under the Apache License, Version 2.0 (the "License"); 5fba2635c088b01af59300e8a02611bb788ee3bffchrismair * you may not use this file except in compliance with the License. 6fba2635c088b01af59300e8a02611bb788ee3bffchrismair * You may obtain a copy of the License at 7fba2635c088b01af59300e8a02611bb788ee3bffchrismair * 8fba2635c088b01af59300e8a02611bb788ee3bffchrismair * http://www.apache.org/licenses/LICENSE-2.0 9fba2635c088b01af59300e8a02611bb788ee3bffchrismair * 10fba2635c088b01af59300e8a02611bb788ee3bffchrismair * Unless required by applicable law or agreed to in writing, software 11fba2635c088b01af59300e8a02611bb788ee3bffchrismair * distributed under the License is distributed on an "AS IS" BASIS, 12fba2635c088b01af59300e8a02611bb788ee3bffchrismair * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13fba2635c088b01af59300e8a02611bb788ee3bffchrismair * See the License for the specific language governing permissions and 14fba2635c088b01af59300e8a02611bb788ee3bffchrismair * limitations under the License. 15fba2635c088b01af59300e8a02611bb788ee3bffchrismair */ 16fba2635c088b01af59300e8a02611bb788ee3bffchrismairpackage org.mockftpserver.core.command; 17fba2635c088b01af59300e8a02611bb788ee3bffchrismair 18fba2635c088b01af59300e8a02611bb788ee3bffchrismair/** 19fba2635c088b01af59300e8a02611bb788ee3bffchrismair * Interface for an object that can retrieve and clear the history of InvocationRecords 20fba2635c088b01af59300e8a02611bb788ee3bffchrismair * for a command handler. 21fba2635c088b01af59300e8a02611bb788ee3bffchrismair * 22fba2635c088b01af59300e8a02611bb788ee3bffchrismair * @version $Revision$ - $Date$ 23fba2635c088b01af59300e8a02611bb788ee3bffchrismair * 24fba2635c088b01af59300e8a02611bb788ee3bffchrismair * @author Chris Mair 25fba2635c088b01af59300e8a02611bb788ee3bffchrismair */ 26fba2635c088b01af59300e8a02611bb788ee3bffchrismairpublic interface InvocationHistory { 27fba2635c088b01af59300e8a02611bb788ee3bffchrismair 28fba2635c088b01af59300e8a02611bb788ee3bffchrismair /** 29fba2635c088b01af59300e8a02611bb788ee3bffchrismair * @return the number of invocation records stored for this command handler instance 30fba2635c088b01af59300e8a02611bb788ee3bffchrismair */ 31fba2635c088b01af59300e8a02611bb788ee3bffchrismair public int numberOfInvocations(); 32fba2635c088b01af59300e8a02611bb788ee3bffchrismair 33fba2635c088b01af59300e8a02611bb788ee3bffchrismair /** 34fba2635c088b01af59300e8a02611bb788ee3bffchrismair * Return the InvocationRecord representing the command invoction data for the nth invocation 35fba2635c088b01af59300e8a02611bb788ee3bffchrismair * for this command handler instance. One InvocationRecord should be stored for each invocation 36fba2635c088b01af59300e8a02611bb788ee3bffchrismair * of the CommandHandler. 37fba2635c088b01af59300e8a02611bb788ee3bffchrismair * 38fba2635c088b01af59300e8a02611bb788ee3bffchrismair * @param index - the index of the invocation record to return. The first record is at index zero. 39fba2635c088b01af59300e8a02611bb788ee3bffchrismair * @return the InvocationRecord for the specified index 40fba2635c088b01af59300e8a02611bb788ee3bffchrismair * 41fba2635c088b01af59300e8a02611bb788ee3bffchrismair * @throws AssertFailedException - if there is no invocation record corresponding to the specified index */ 42fba2635c088b01af59300e8a02611bb788ee3bffchrismair public InvocationRecord getInvocation(int index); 43fba2635c088b01af59300e8a02611bb788ee3bffchrismair 44fba2635c088b01af59300e8a02611bb788ee3bffchrismair /** 45fba2635c088b01af59300e8a02611bb788ee3bffchrismair * Clear out the invocation history for this CommandHandler. After invoking this method, the 46fba2635c088b01af59300e8a02611bb788ee3bffchrismair * <code>numberOfInvocations()</code> method will return zero. 47fba2635c088b01af59300e8a02611bb788ee3bffchrismair */ 48fba2635c088b01af59300e8a02611bb788ee3bffchrismair public void clearInvocations(); 49fba2635c088b01af59300e8a02611bb788ee3bffchrismair 50fba2635c088b01af59300e8a02611bb788ee3bffchrismair}