Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
package net.sf.expectit;
/*
* #%L
* ExpectIt
* %%
* Copyright (C) 2014 Alexey Gavrilov and contributors
* %%
* 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.
* #L%
*/
import java.io.Closeable;
import java.io.IOException;
import java.util.concurrent.TimeUnit;
import net.sf.expectit.interact.InteractBuilder;
import net.sf.expectit.matcher.Matcher;
/**
* The main interface providing access to the expect operations.
*
* Input data for the operations is stored in the internal buffer growing while new data is being
* received from
* the underlying input stream.
* A successful match operation updates the buffer by removing a part from the begging until the
* end position of the
* match.
*
* The send methods are thread safe as long as the underlying output streams
* are thread safe. In other words it is safe to send data from one thread and expect the
* results in another.
*/
public interface Expect extends Closeable {
/**
* Sends the string to the output stream and flushes the output.
*
* The string is converted to bytes using {@code charset} set in the {@link net.sf.expectit
* .ExpectBuilder}.
*
* @param string the string to be sent
* @return this
* @throws IOException if I/O error occurs
*/
Expect send(String string) throws IOException;
/**
* Appends the line separator character to the string and calls {@link #send(String)} method.
*
* @param string the string to be sent
* @return this
* @throws IOException if I/O error occurs
* @see #send(String)
* @see net.sf.expectit.ExpectBuilder#withLineSeparator(String)
*/
Expect sendLine(String string) throws IOException;
/**
* Sends a new line to the output. Simply calls the {@link #sendLine(String)} method with
* empty string as a
* parameter.
*
* @return this
* @throws IOException if I/O error occurs
*/
Expect sendLine() throws IOException;
/**
* Sends the given byte array and flushes the output.
*
* @param bytes the bytes to be sent
* @return this
* @throws IOException if I/O error occurs
*/
Expect sendBytes(byte[] bytes) throws IOException;
/**
* Blocks until the given matcher matches against the first input stream using the default
* timeout.
*
* The method throws an {@link java.lang.AssertionError} if
* {@link net.sf.expectit.ExpectBuilder#errorOnTimeout} is set. Deprecated.
*
* An instance of {@link java.io.EOFException} will be thrown if the underlying input steam,
* the internal buffer
* is empty and the match operation is not successful.
*
* @param the matcher type
* @param matcher the mather
* @return the match result
* @throws ExpectIOException if the matcher does not match and the
* the {@link net.sf.expectit.ExpectBuilder#withExceptionOnFailure()} flag was set
* @throws java.nio.channels.ClosedByInterruptException if the thread calling this method has
* been interrupted
* @throws java.io.IOException if an I/O error occurs
*/
R expect(Matcher matcher) throws IOException;
/**
* Blocks until all the given matchers match against the first input stream using the default
* timeout.
*
* The method throws an {@link java.lang.AssertionError} if
* {@link net.sf.expectit.ExpectBuilder#errorOnTimeout} is set. Deprecated.
*
* An instance of {@link java.io.EOFException} will be thrown if the underlying input steam,
* the internal buffer
* is empty and the match operation is not successful.
*
* @param matchers the matchers
* @return the match result from all the matchers
* @throws ExpectIOException if the matcher does not match and the
* the {@link net.sf.expectit.ExpectBuilder#withExceptionOnFailure()} flag was set
* @throws java.nio.channels.ClosedByInterruptException if the thread calling this method has
* been interrupted
* @throws java.io.IOException if an I/O error occurs
*/
MultiResult expect(Matcher... matchers) throws IOException;
/**
* Blocks until the given matcher matches the first input stream using the given timeout.
*
* The method throws an {@link java.lang.AssertionError} if
* {@link net.sf.expectit.ExpectBuilder#errorOnTimeout} is set. Deprecated.
*
* An instance of {@link java.io.EOFException} will be thrown if the underlying input stream,
* the internal buffer
* is empty and the match operation is not successful.
*
* @param the matcher type
* @param timeoutMs the timeout for the expect operation in milliseconds,
* infinite if -1 is passed
* @param matcher the mather
* @return the match result
* @throws ExpectIOException if the matcher does not match and the
* the {@link ExpectBuilder#withExceptionOnFailure()} flag was set
* @throws java.nio.channels.ClosedByInterruptException if the thread calling this method has
* been interrupted
* @throws IOException if an I/O error occurs
* @deprecated This method is deprecated and will be removed. Use
* {@link #withTimeout(long, java.util.concurrent.TimeUnit)} to change the timeout for the
* expect operation.
*/
@Deprecated
R expect(long timeoutMs, Matcher matcher) throws IOException;
/**
* Blocks until all the given matchers match the first input stream using the given timeout.
*
* The method throws an {@link java.lang.AssertionError} if
* {@link net.sf.expectit.ExpectBuilder#errorOnTimeout} is set. Deprecated.
*
* An instance of {@link java.io.EOFException} will be thrown if the underlying input steam,
* the internal buffer
* is empty and the match operation is not successful.
*
* @param timeoutMs the timeout for the expect operation in milliseconds,
* infinite if -1 is passed
* @param matcher the matchers
* @return the match result from all the matchers
* @throws ExpectIOException if the matcher does not match and the
* the {@link net.sf.expectit.ExpectBuilder#withExceptionOnFailure()} flag was set
* @throws java.nio.channels.ClosedByInterruptException if the thread calling this method has
* been interrupted
* @throws java.io.IOException if an I/O error occurs
* @deprecated This method is deprecated and will be removed. Use
* {@link #withTimeout(long, java.util.concurrent.TimeUnit)} to change the timeout for the
* expect operation.
*/
@Deprecated
MultiResult expect(long timeoutMs, Matcher... matcher) throws IOException;
/**
* Blocks until the given matcher matches against the given input stream using the default
* timeout.
*
* The method throws an {@link java.lang.AssertionError} if
* {@link net.sf.expectit.ExpectBuilder#errorOnTimeout} is set. Deprecated.
*
* An instance of {@link java.io.EOFException} will be thrown if the underlying input steam,
* the internal buffer
* is empty and the match operation is not successful.
*
* @param the matcher type
* @param input the index of the input. if the index is outside of the boundaries,
* a runtime exception will be
* thrown
* @param matcher the matcher
* @return the match result
* @throws ExpectIOException if the matcher does not match and the
* the {@link net.sf.expectit.ExpectBuilder#withExceptionOnFailure()} flag was set
* @throws java.nio.channels.ClosedByInterruptException if the thread calling this method has
* been interrupted
* @throws java.io.IOException if an I/O error occurs
*/
R expectIn(int input, Matcher matcher) throws IOException;
/**
* Blocks until the given matcher matches against the given input stream using the given
* timeout.
*
* The method throws an {@link java.lang.AssertionError} if
* {@link net.sf.expectit.ExpectBuilder#errorOnTimeout} is set. Deprecated.
*
* @param the matcher type
* @param input the index of the input. if the index is outside of the boundaries,
* a runtime exception will be
* thrown
* @param timeoutMs the timeout for the expect operation in milliseconds,
* infinite if -1 is passed
* @param matcher the mather
* @return the match result
* @throws ExpectIOException if the matcher does not match and the
* the {@link net.sf.expectit.ExpectBuilder#withExceptionOnFailure()} flag was set
* @throws java.nio.channels.ClosedByInterruptException if the thread calling this method has
* been interrupted
* @throws java.io.IOException if an I/O error occurs
* @deprecated This method is deprecated and will be removed. Use
* {@link #withTimeout(long, java.util.concurrent.TimeUnit)} to change the timeout for the
* expect operation.
*/
@Deprecated
R expectIn(int input, long timeoutMs, Matcher matcher) throws IOException;
/**
* Blocks until all the given matchers matche against the given input stream using the given
* timeout.
*
* The method throws an {@link java.lang.AssertionError} if
* {@link net.sf.expectit.ExpectBuilder#errorOnTimeout} is set. Deprecated.
*
* An instance of {@link java.io.EOFException} will be thrown if the underlying input steam,
* the internal buffer
* is empty and the match operation is not successful.
*
* @param input the index of the input. if the index is outside of the boundaries,
* a runtime exception will be
* thrown
* @param timeoutMs the timeout for the expect operation in milliseconds,
* infinite if -1 is passed
* @param matchers the matchers
* @return the match result from all the matchers
* @throws ExpectIOException if the matcher does not match and the
* the {@link net.sf.expectit.ExpectBuilder#withExceptionOnFailure()} flag was set
* @throws java.nio.channels.ClosedByInterruptException if the thread calling this method has
* been interrupted
* @throws java.io.IOException if an I/O error occurs
* @deprecated This method is deprecated and will be removed. Use
* {@link #withTimeout(long, java.util.concurrent.TimeUnit)} to change the timeout for the
* expect operation.
*/
@Deprecated
MultiResult expectIn(int input, long timeoutMs, Matcher... matchers) throws IOException;
/**
* Sets the default timeout in the given unit for the expect operations for the returned
* instance. The timeout for
* this instance will remain unchanged. Both instances, this and the returned one,
* will share the same configuration
* except the default timeout value.
*
* @param duration the timeout value
* @param unit the time unit
* @return an Expect instance with a new default timeout.
* @throws java.lang.IllegalArgumentException if the timeout {@code <= 0}
*/
Expect withTimeout(long duration, TimeUnit unit);
/**
* Sets the default timeout to infinity. The timeout for this instance will remain unchanged.
* Both instances, this
* and the returned one, will share the same configuration except the default timeout value.
*
* @return an Expect instance with a new default timeout.
*/
Expect withInfiniteTimeout();
/**
* Closes all resources associated with this instance.
*
* @throws IOException if I/O error occurs
*/
@Override
void close() throws IOException;
/**
* Starts the interactive loop for the first input.
*
* @return the interact builder.
*/
InteractBuilder interact();
/**
* Starts the interactive loop for the given input.
*
* @param input the index of the input stream to use for the interact loop.
* @return the interact builder.
*/
InteractBuilder interactWith(int input);
}
