Package com.casioeurope.mis.edt.type
Class ReadWriteFileParams.Builder
Object
Builder
- Enclosing class:
- ReadWriteFileParams
public static final class ReadWriteFileParams.Builder extends Object
Provides a convenient way to set the fields of a
ReadWriteFileParams
object when creating a new
instance, following the Builder pattern. The following setting is required to build a ReadWriteFileParams
object:
path
The example below shows how you might create a new ReadWriteFileParams
object instance:
// Create a ReadWriteFileParams object instance with a data buffer of 4K,
// for read operation starting after 1 byte, accessing the buffer from index 2 onwards, reading a hundred bytes.
byte[] testData = new byte[4096];
ReadWriteFileParams readWriteFileParams = ReadWriteFileParams.setPath(Paths.get("/sdcard/Download/devinfo.html"))
.setData(testData)
.setFileOffset(1)
.setDataOffset(2)
.setLength(100)
.setOptions(StandardOpenOption.READ)
.build();
- Since:
- 1.00
-
Method Summary
Modifier and Type Method Description ReadWriteFileParams
build()
This method is used to finally instantiate aReadWriteFileParams
object from thisBuilder
, after all optional chaining has been done.ReadWriteFileParams.Builder
setData(byte[] data)
Adds a buffer holding the data to be read/written, using Builder pattern method chaining.ReadWriteFileParams.Builder
setDataOffset(int dataOffset)
Adds a Data Offset value using Builder pattern method chaining.ReadWriteFileParams.Builder
setFileOffset(int fileOffset)
Adds a File Offset value using Builder pattern method chaining.ReadWriteFileParams.Builder
setLength(int length)
Adds a Data Length value using Builder pattern method chaining.ReadWriteFileParams.Builder
setOptions(OpenOption... openOptions)
-
Method Details
-
build
This method is used to finally instantiate aReadWriteFileParams
object from thisBuilder
, after all optional chaining has been done.- Returns:
ReadWriteFileParams
: instance object created from Builder pattern.- Since:
- 1.00
-
setData
Adds a buffer holding the data to be read/written, using Builder pattern method chaining.When using the
writeFile
method, providing a data buffer (and data accordingly, logically) is mandatory.
In contrast, when using thereadFile
method, providing a data buffer is optional.
IfreadFile
method is called with a data buffer provided, the method call will fail if the data buffer is insufficient to hold the data being read.
IfreadFile
method is called without providing a data buffer i.e. when getData() equalsnull
, the method call will dynamically allocate a buffer holding the data being read. -
setDataOffset
Adds a Data Offset value using Builder pattern method chaining. -
setFileOffset
Adds a File Offset value using Builder pattern method chaining. -
setLength
Adds a Data Length value using Builder pattern method chaining. -
setOptions
- Parameters:
openOptions
-StandardOpenOptions
and/orLinkOptions
: Variable number of Options to be applied- Returns:
- The instance object of this
Builder
, with a mandatory filepath
set, and furtherStandardOpenOptions
and/orLinkOptions
applied. - Since:
- 1.00
-