185efb15529d45e32fea8de03c38a968c157c8262chrismair/* 285efb15529d45e32fea8de03c38a968c157c8262chrismair * Copyright 2007 the original author or authors. 385efb15529d45e32fea8de03c38a968c157c8262chrismair * 485efb15529d45e32fea8de03c38a968c157c8262chrismair * Licensed under the Apache License, Version 2.0 (the "License"); 585efb15529d45e32fea8de03c38a968c157c8262chrismair * you may not use this file except in compliance with the License. 685efb15529d45e32fea8de03c38a968c157c8262chrismair * You may obtain a copy of the License at 785efb15529d45e32fea8de03c38a968c157c8262chrismair * 885efb15529d45e32fea8de03c38a968c157c8262chrismair * http://www.apache.org/licenses/LICENSE-2.0 985efb15529d45e32fea8de03c38a968c157c8262chrismair * 1085efb15529d45e32fea8de03c38a968c157c8262chrismair * Unless required by applicable law or agreed to in writing, software 1185efb15529d45e32fea8de03c38a968c157c8262chrismair * distributed under the License is distributed on an "AS IS" BASIS, 1285efb15529d45e32fea8de03c38a968c157c8262chrismair * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1385efb15529d45e32fea8de03c38a968c157c8262chrismair * See the License for the specific language governing permissions and 1485efb15529d45e32fea8de03c38a968c157c8262chrismair * limitations under the License. 1585efb15529d45e32fea8de03c38a968c157c8262chrismair */ 1685efb15529d45e32fea8de03c38a968c157c8262chrismairpackage org.mockftpserver.core.command; 1785efb15529d45e32fea8de03c38a968c157c8262chrismair 1885efb15529d45e32fea8de03c38a968c157c8262chrismair/** 1985efb15529d45e32fea8de03c38a968c157c8262chrismair * Interface for an object that can retrieve and clear the history of InvocationRecords 2085efb15529d45e32fea8de03c38a968c157c8262chrismair * for a command handler. 2185efb15529d45e32fea8de03c38a968c157c8262chrismair * 2285efb15529d45e32fea8de03c38a968c157c8262chrismair * @version $Revision$ - $Date$ 2385efb15529d45e32fea8de03c38a968c157c8262chrismair * 2485efb15529d45e32fea8de03c38a968c157c8262chrismair * @author Chris Mair 2585efb15529d45e32fea8de03c38a968c157c8262chrismair */ 2685efb15529d45e32fea8de03c38a968c157c8262chrismairpublic interface InvocationHistory { 2785efb15529d45e32fea8de03c38a968c157c8262chrismair 2885efb15529d45e32fea8de03c38a968c157c8262chrismair /** 2985efb15529d45e32fea8de03c38a968c157c8262chrismair * @return the number of invocation records stored for this command handler instance 3085efb15529d45e32fea8de03c38a968c157c8262chrismair */ 3185efb15529d45e32fea8de03c38a968c157c8262chrismair public int numberOfInvocations(); 3285efb15529d45e32fea8de03c38a968c157c8262chrismair 3385efb15529d45e32fea8de03c38a968c157c8262chrismair /** 3485efb15529d45e32fea8de03c38a968c157c8262chrismair * Return the InvocationRecord representing the command invoction data for the nth invocation 3585efb15529d45e32fea8de03c38a968c157c8262chrismair * for this command handler instance. One InvocationRecord should be stored for each invocation 3685efb15529d45e32fea8de03c38a968c157c8262chrismair * of the CommandHandler. 3785efb15529d45e32fea8de03c38a968c157c8262chrismair * 3885efb15529d45e32fea8de03c38a968c157c8262chrismair * @param index - the index of the invocation record to return. The first record is at index zero. 3985efb15529d45e32fea8de03c38a968c157c8262chrismair * @return the InvocationRecord for the specified index 4085efb15529d45e32fea8de03c38a968c157c8262chrismair * 4185efb15529d45e32fea8de03c38a968c157c8262chrismair * @throws AssertFailedException - if there is no invocation record corresponding to the specified index */ 4285efb15529d45e32fea8de03c38a968c157c8262chrismair public InvocationRecord getInvocation(int index); 4385efb15529d45e32fea8de03c38a968c157c8262chrismair 4485efb15529d45e32fea8de03c38a968c157c8262chrismair /** 4585efb15529d45e32fea8de03c38a968c157c8262chrismair * Clear out the invocation history for this CommandHandler. After invoking this method, the 4685efb15529d45e32fea8de03c38a968c157c8262chrismair * <code>numberOfInvocations()</code> method will return zero. 4785efb15529d45e32fea8de03c38a968c157c8262chrismair */ 4885efb15529d45e32fea8de03c38a968c157c8262chrismair public void clearInvocations(); 4985efb15529d45e32fea8de03c38a968c157c8262chrismair 5085efb15529d45e32fea8de03c38a968c157c8262chrismair}