Modifier and Type	Class and Description
private class	ResettableFileInputStream.AlreadyWrappedState This is for streams that are already wrapped, i.e. `WrappedFileInputStream`.
private class	ResettableFileInputStream.NeedsToBeWrappedState This is for `FileInputStream`s that are not already wrapped.
private static interface	ResettableFileInputStream.State State interface for dealing with mark and reset.

Modifier and Type	Field and Description
private final boolean	alreadyWrapped
private static final Logger	LOG
private final ResettableFileInputStream.State	state

Access	Constructor and Description
public	ResettableFileInputStream(FileInputStream file input stream to wrap fis) Constructor for a file input stream that provides mark-and-reset capabilities.

Method Summary

Modifier and Type	Method and Description
public static boolean	Returns: true if it can be wrapped canBeWrapped(FileInputStream the `FileInputStream` to check fis) Return true if the provided `FileInputStream` can be wrapped to provide mark-and-reset capabilities.
public static boolean	Returns: true if it is already wrapped isAlreadyWrapped(FileInputStream the `FileInputStream` to check fis) Return true if the provided `FileInputStream` has already been wrapped, and therefore supports mark-and-reset capabilities.
public synchronized void	mark(int the maximum limit of bytes that can be read before the mark position becomes invalid. readlimit) Overrides java.io.FilterInputStream.mark. Marks the current position in this input stream.
public boolean	markSupported() Overrides java.io.FilterInputStream.markSupported. Tests if this input stream supports the `mark` and `reset` methods.
public synchronized void	reset() Overrides java.io.FilterInputStream.reset. Repositions this stream to the position at the time the `mark` method was last called on this input stream.

Inherited from java.io.FilterInputStream:: available close read read read skip

Field Detail

alreadyWrapped	back to summary
private final boolean alreadyWrapped

LOG	back to summary
private static final Logger LOG

state	back to summary
private final ResettableFileInputStream.State state

Constructor Detail

ResettableFileInputStream	back to summary
public ResettableFileInputStream(FileInputStream fis) Constructor for a file input stream that provides mark-and-reset capabilities. Parameters fis:FileInputStream file input stream to wrap Exceptions IllegalArgumentException: if the file channel of the file input stream does not provide a position

ResettableFileInputStream

back to summary

public ResettableFileInputStream(FileInputStream fis)

Constructor for a file input stream that provides mark-and-reset capabilities.

Parameters

fis:FileInputStream: file input stream to wrap

Exceptions

IllegalArgumentException:: if the file channel of the file input stream does not provide a position

Method Detail

canBeWrapped back to summary

canBeWrapped	back to summary
public static boolean canBeWrapped(FileInputStream fis) Return true if the provided `FileInputStream` can be wrapped to provide mark-and-reset capabilities. Parameters fis:FileInputStream the `FileInputStream` to check Returns:boolean true if it can be wrapped

public static boolean canBeWrapped(FileInputStream fis)

Return true if the provided FileInputStream can be wrapped to provide mark-and-reset capabilities.

Parameters

fis:FileInputStream: the FileInputStream to check

Returns:boolean

true if it can be wrapped

isAlreadyWrapped back to summary

isAlreadyWrapped	back to summary
public static boolean isAlreadyWrapped(FileInputStream fis) Return true if the provided `FileInputStream` has already been wrapped, and therefore supports mark-and-reset capabilities. Parameters fis:FileInputStream the `FileInputStream` to check Returns:boolean true if it is already wrapped

public static boolean isAlreadyWrapped(FileInputStream fis)

Return true if the provided FileInputStream has already been wrapped, and therefore supports mark-and-reset capabilities.

Parameters

fis:FileInputStream: the FileInputStream to check

Returns:boolean

true if it is already wrapped

mark back to summary

mark	back to summary
public synchronized void mark(int readlimit) Overrides java.io.FilterInputStream.mark. Doc from java.io.FilterInputStream.mark. Marks the current position in this input stream. A subsequent call to the `reset` method repositions this stream at the last marked position so that subsequent reads re-read the same bytes. The `readlimit` argument tells this input stream to allow that many bytes to be read before the mark position gets invalidated. Parameters readlimit:int the maximum limit of bytes that can be read before the mark position becomes invalid. Annotations @Override

public synchronized void mark(int readlimit)

Overrides java.io.FilterInputStream.mark.

Doc from java.io.FilterInputStream.mark.

Marks the current position in this input stream. A subsequent call to the reset method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.

The readlimit argument tells this input stream to allow that many bytes to be read before the mark position gets invalidated.

Parameters

readlimit:int: the maximum limit of bytes that can be read before the mark position becomes invalid.

Annotations

@Override

markSupported back to summary

markSupported	back to summary
public boolean markSupported() Overrides java.io.FilterInputStream.markSupported. Doc from java.io.FilterInputStream.markSupported. Tests if this input stream supports the `mark` and `reset` methods. Returns:boolean `true` if this stream type supports the `mark` and `reset` method; `false` otherwise. Annotations @Override

public boolean markSupported()

Overrides java.io.FilterInputStream.markSupported.

Doc from java.io.FilterInputStream.markSupported.

Tests if this input stream supports the mark and reset methods.

Returns:boolean

true if this stream type supports the mark and reset method; false otherwise.

Annotations

@Override

reset back to summary

reset	back to summary
public synchronized void reset() throws IOException Overrides java.io.FilterInputStream.reset. Doc from java.io.FilterInputStream.reset. Repositions this stream to the position at the time the `mark` method was last called on this input stream. Stream marks are intended to be used in situations where you need to read ahead a little to see what's in the stream. Often this is most easily done by invoking some general parser. If the stream is of the type handled by the parse, it just chugs along happily. If the stream is not of that type, the parser should toss an exception when it fails. If this happens within readlimit bytes, it allows the outer code to reset the stream and try another parser. Annotations @Override Exceptions IOException: if this stream has not been marked or if the mark has been invalidated.

public synchronized void reset() throws IOException

Overrides java.io.FilterInputStream.reset.

Doc from java.io.FilterInputStream.reset.

Repositions this stream to the position at the time the mark method was last called on this input stream.

Stream marks are intended to be used in situations where you need to read ahead a little to see what's in the stream. Often this is most easily done by invoking some general parser. If the stream is of the type handled by the parse, it just chugs along happily. If the stream is not of that type, the parser should toss an exception when it fails. If this happens within readlimit bytes, it allows the outer code to reset the stream and try another parser.

Annotations

@Override

Exceptions

IOException:: if this stream has not been marked or if the mark has been invalidated.

com.oracle.bmc.io.internal back to summary

private final Class ResettableFileInputStream.AlreadyWrappedState

Class Inheritance

extends Object
implements State

java.lang.Object
com.oracle.bmc.io.internal.ResettableFileInputStream.AlreadyWrappedState

All Implemented Interfaces

com.oracle.bmc.io.internal.ResettableFileInputStream.State

This is for streams that are already wrapped, i.e. WrappedFileInputStream.

Constructor Summary

Access	Constructor and Description
private	AlreadyWrappedState()

Method Summary

Modifier and Type	Method and Description
public synchronized void	mark(int readlimit) Implements com.oracle.bmc.io.internal.ResettableFileInputStream.State.mark.
public synchronized void	reset() Implements com.oracle.bmc.io.internal.ResettableFileInputStream.State.reset.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

AlreadyWrappedState	back to summary
private AlreadyWrappedState()

Method Detail

mark	back to summary
public synchronized void mark(int readlimit) Implements com.oracle.bmc.io.internal.ResettableFileInputStream.State.mark. Annotations @Override

mark

back to summary

public synchronized void mark(int readlimit)

Implements com.oracle.bmc.io.internal.ResettableFileInputStream.State.mark.

Annotations

@Override

reset	back to summary
public synchronized void reset() throws IOException Implements com.oracle.bmc.io.internal.ResettableFileInputStream.State.reset. Annotations @Override

reset

back to summary

public synchronized void reset() throws IOException

Implements com.oracle.bmc.io.internal.ResettableFileInputStream.State.reset.

Annotations

@Override

com.oracle.bmc.io.internal back to summary

private final Class ResettableFileInputStream.NeedsToBeWrappedState

Class Inheritance

extends Object
implements State

java.lang.Object
com.oracle.bmc.io.internal.ResettableFileInputStream.NeedsToBeWrappedState

All Implemented Interfaces

com.oracle.bmc.io.internal.ResettableFileInputStream.State

This is for FileInputStreams that are not already wrapped.

Field Summary

Modifier and Type	Field and Description
private FileChannel	fileChannel
private long	markPosition

Constructor Summary

Access	Constructor and Description
public	NeedsToBeWrappedState(FileChannel fileChannel)

Method Summary

Modifier and Type	Method and Description
public synchronized void	mark(int readlimit) Implements com.oracle.bmc.io.internal.ResettableFileInputStream.State.mark.
public synchronized void	reset() Implements com.oracle.bmc.io.internal.ResettableFileInputStream.State.reset.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

fileChannel	back to summary
private FileChannel fileChannel

markPosition	back to summary
private long markPosition

Constructor Detail

NeedsToBeWrappedState	back to summary
public NeedsToBeWrappedState(FileChannel fileChannel)

Method Detail

mark	back to summary
public synchronized void mark(int readlimit) Implements com.oracle.bmc.io.internal.ResettableFileInputStream.State.mark. Annotations @Override

mark

back to summary

public synchronized void mark(int readlimit)

Implements com.oracle.bmc.io.internal.ResettableFileInputStream.State.mark.

Annotations

@Override

reset	back to summary
public synchronized void reset() throws IOException Implements com.oracle.bmc.io.internal.ResettableFileInputStream.State.reset. Annotations @Override

reset

back to summary

public synchronized void reset() throws IOException

Implements com.oracle.bmc.io.internal.ResettableFileInputStream.State.reset.

Annotations

@Override

com.oracle.bmc.io.internal back to summary

private Interface ResettableFileInputStream.State

Known Direct Implementers: com.oracle.bmc.io.internal.ResettableFileInputStream.AlreadyWrappedState, com.oracle.bmc.io.internal.ResettableFileInputStream.NeedsToBeWrappedState

State interface for dealing with mark and reset.

Method Summary

Modifier and Type	Method and Description
public void	mark(int readlimit)
public void	reset()

Method Detail

mark	back to summary
public void mark(int readlimit) See Also `java.io.InputStream#mark(int)`

reset	back to summary
public void reset() throws IOException See Also `InputStream#reset()`

public Class ResettableFileInputStream

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ResettableFileInputStream.AlreadyWrappedState

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class ResettableFileInputStream.NeedsToBeWrappedState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Interface ResettableFileInputStream.State

Method Summary

Method Detail