sfcc-dev-mcp 1.0.16 → 1.0.20

package/docs/dw_io/FileWriter.md

@@ -1,103 +0,0 @@
-## Package: dw.io
-
-# Class FileWriter
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.io.Writer
-  - dw.io.FileWriter
-
-## Description
-
-Convenience class for writing character files. Files are stored in a shared file system where multiple processes could access the same file. The client code is responsible for ensuring that no more than one process writes to a file at a given time. Note: when this class is used with sensitive data, be careful in persisting sensitive information to disk.
-
-## Properties
-
-### lineSeparator
-
-**Type:** String
-
-Get the current line separator (e.g. '\n' or '\r\n'), if no value is set the system default '\n' will be used.
-
-## Constructor Summary
-
-FileWriter(file : File) Constructs the writer for the specified file.
-
-FileWriter(file : File, append : boolean) Constructs the writer for the specified file.
-
-FileWriter(file : File, encoding : String) Constructs the writer for the specified file with the specified encoding.
-
-FileWriter(file : File, encoding : String, append : boolean) Constructs the writer for the specified file with the specified encoding.
-
-## Method Summary
-
-### close
-
-**Signature:** `close() : void`
-
-Closes the writer.
-
-### getLineSeparator
-
-**Signature:** `getLineSeparator() : String`
-
-Get the current line separator (e.g.
-
-### setLineSeparator
-
-**Signature:** `setLineSeparator(lineSeparator : String) : void`
-
-Set the line separator (e.g.
-
-### writeLine
-
-**Signature:** `writeLine(str : String) : void`
-
-Writes the specified line and appends the line separator.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### close
-
-**Signature:** `close() : void`
-
-**Description:** Closes the writer.
-
----
-
-### getLineSeparator
-
-**Signature:** `getLineSeparator() : String`
-
-**Description:** Get the current line separator (e.g. '\n' or '\r\n'), if no value is set the system default '\n' will be used.
-
----
-
-### setLineSeparator
-
-**Signature:** `setLineSeparator(lineSeparator : String) : void`
-
-**Description:** Set the line separator (e.g. '\n' or '\r\n'), if no value is set the system default '\n' will be used.
-
-**Parameters:**
-
-- `lineSeparator`: that will be written at the end of each line
-
----
-
-### writeLine
-
-**Signature:** `writeLine(str : String) : void`
-
-**Description:** Writes the specified line and appends the line separator.
-
-**Parameters:**
-
-- `str`: the line to write to the file.
-
----

package/docs/dw_io/InputStream.md

@@ -1,34 +0,0 @@
-## Package: dw.io
-
-# Class InputStream
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.io.InputStream
-
-## Description
-
-The class represent a stream of bytes that can be read from the application. The InputStream itself doesn't provide any methods to read the data. Instead the InputStream can be chained with other classes like a XMLStreamReader to read data.
-
-## Constructor Summary
-
-## Method Summary
-
-### close
-
-**Signature:** `close() : void`
-
-Closes the input stream.
-
-## Method Detail
-
-## Method Details
-
-### close
-
-**Signature:** `close() : void`
-
-**Description:** Closes the input stream.
-
----

package/docs/dw_io/OutputStream.md

@@ -1,34 +0,0 @@
-## Package: dw.io
-
-# Class OutputStream
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.io.OutputStream
-
-## Description
-
-The class represent a stream of bytes that can be written from the application. The OutputStream itself doesn't provide any methods to write the data. Instead the OutputStream can be chained with other classes like a XMLStreamWriter to write data. Note: when this class is used with sensitive data, be careful in persisting sensitive information to disk.
-
-## Constructor Summary
-
-## Method Summary
-
-### close
-
-**Signature:** `close() : void`
-
-Closes the output stream.
-
-## Method Detail
-
-## Method Details
-
-### close
-
-**Signature:** `close() : void`
-
-**Description:** Closes the output stream.
-
----

package/docs/dw_io/PrintWriter.md

@@ -1,71 +0,0 @@
-## Package: dw.io
-
-# Class PrintWriter
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.io.Writer
-  - dw.io.PrintWriter
-
-## Description
-
-Template output stream writer. Printwriter is available in the template scripting context and is used to write data into the template output stream. You cannot instantiate this class directly. Instead, the system assigns the object to variable named 'out' in the script context to be used by the template scripts. Note: when this class is used with sensitive data, be careful in persisting sensitive information to disk.
-
-## Constructor Summary
-
-## Method Summary
-
-### print
-
-**Signature:** `print(str : String) : void`
-
-Prints the given string into the output stream.
-
-### println
-
-**Signature:** `println(str : String) : void`
-
-Print the given string followed by a line break into the output stream.
-
-### println
-
-**Signature:** `println() : void`
-
-Prints a line break into the output stream.
-
-## Method Detail
-
-## Method Details
-
-### print
-
-**Signature:** `print(str : String) : void`
-
-**Description:** Prints the given string into the output stream.
-
-**Parameters:**
-
-- `str`: the String object
-
----
-
-### println
-
-**Signature:** `println(str : String) : void`
-
-**Description:** Print the given string followed by a line break into the output stream.
-
-**Parameters:**
-
-- `str`: the String object
-
----
-
-### println
-
-**Signature:** `println() : void`
-
-**Description:** Prints a line break into the output stream.
-
----

package/docs/dw_io/RandomAccessFileReader.md

@@ -1,173 +0,0 @@
-## Package: dw.io
-
-# Class RandomAccessFileReader
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.io.RandomAccessFileReader
-
-## Description
-
-Instances of this class support reading from a random access file. A random access file behaves like a large array of bytes stored in the file system. There is a kind of cursor, or index into the implied array, called the file pointer. Read operations read bytes starting at the file pointer and advance the file pointer past the bytes read. The file pointer can be read by the getPosition method and set by the setPosition method.
-
-## Constants
-
-### MAX_READ_BYTES
-
-**Type:** Number = 10240L
-
-The maximum number of bytes that a single call to readBytes(Number) can return == 10KB
-
-## Properties
-
-### position
-
-**Type:** Number
-
-The current offset in this file.
-
-## Constructor Summary
-
-RandomAccessFileReader(file : File) Construct a reader for random read access to the provided file.
-
-## Method Summary
-
-### close
-
-**Signature:** `close() : void`
-
-Closes this random access file reader and releases any system resources associated with the stream.
-
-### getPosition
-
-**Signature:** `getPosition() : Number`
-
-Returns the current offset in this file.
-
-### length
-
-**Signature:** `length() : Number`
-
-Returns the length of this file.
-
-### readByte
-
-**Signature:** `readByte() : Number`
-
-Reads a signed eight-bit value from the file starting from the current file pointer.
-
-### readBytes
-
-**Signature:** `readBytes(numBytes : Number) : Bytes`
-
-Reads up to n bytes from the file starting at the current file pointer.
-
-### setPosition
-
-**Signature:** `setPosition(position : Number) : void`
-
-Sets the file-pointer offset, measured from the beginning of this file, at which the next read occurs.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### close
-
-**Signature:** `close() : void`
-
-**Description:** Closes this random access file reader and releases any system resources associated with the stream.
-
-**Throws:**
-
-IOException - if an I/O error occurs.
-
----
-
-### getPosition
-
-**Signature:** `getPosition() : Number`
-
-**Description:** Returns the current offset in this file.
-
-**Returns:**
-
-the offset from the beginning of the file, in bytes, at which the next read occurs.
-
-**Throws:**
-
-IOException - if an I/O error occurs.
-
----
-
-### length
-
-**Signature:** `length() : Number`
-
-**Description:** Returns the length of this file.
-
-**Returns:**
-
-the length of this file, measured in bytes.
-
-**Throws:**
-
-IOException - if an I/O error occurs.
-
----
-
-### readByte
-
-**Signature:** `readByte() : Number`
-
-**Description:** Reads a signed eight-bit value from the file starting from the current file pointer. Since the byte is interpreted as signed, the value returned will always be between -128 and +127.
-
-**Returns:**
-
-the next byte of this file as a signed eight-bit byte.
-
-**Throws:**
-
-IOException - if an I/O error occurs or if this file has reached the end.
-
----
-
-### readBytes
-
-**Signature:** `readBytes(numBytes : Number) : Bytes`
-
-**Description:** Reads up to n bytes from the file starting at the current file pointer. If there are fewer than n bytes remaining in the file, then as many bytes as possible are read. If no bytes remain in the file, then null is returned.
-
-**Parameters:**
-
-- `numBytes`: The number of bytes to read. Must be non-negative and smaller than MAX_READ_BYTES or an exception will be thrown.
-
-**Returns:**
-
-A Bytes object representing the read bytes or null if no bytes were read.
-
-**Throws:**
-
-IOException - if an I/O error occurs.
-IllegalArgumentException - if numBytes< 0 or numBytes > MAX_READ_BYTES.
-
----
-
-### setPosition
-
-**Signature:** `setPosition(position : Number) : void`
-
-**Description:** Sets the file-pointer offset, measured from the beginning of this file, at which the next read occurs. The offset may be set beyond the end of the file.
-
-**Parameters:**
-
-- `position`: the offset position, measured in bytes from the beginning of the file, at which to set the file pointer
-
-**Throws:**
-
-IOException - if position is less than 0 or if an I/O error occurs.
-
----

package/docs/dw_io/Reader.md

@@ -1,274 +0,0 @@
-## Package: dw.io
-
-# Class Reader
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.io.Reader
-
-## Description
-
-The class supports reading characters from a stream.
-
-## Properties
-
-### lines
-
-**Type:** List (Read Only)
-
-The method reads the whole input stream, parses it and returns a list of strings.
- 
- Using this method on large feeds is inherently unsafe and may lead to an out-of-memory condition. Instead use
- method readLine() and process one line at a time.
-
-### string
-
-**Type:** String (Read Only)
-
-The method reads the whole input stream as one string and returns it.
- 
- Using this method is unsafe if the length of the input stream is not known and may lead to an out-of-memory
- condition. Instead use method readN(Number).
-
-## Constructor Summary
-
-Reader(source : String) Creates a reader from a string.
-
-Reader(stream : InputStream) Create a reader from a stream using UTF-8 character encoding.
-
-Reader(stream : InputStream, encoding : String) Create a reader from a stream using the specified character encoding.
-
-## Method Summary
-
-### close
-
-**Signature:** `close() : void`
-
-Closes the reader.
-
-### getLines
-
-**Signature:** `getLines() : List`
-
-The method reads the whole input stream, parses it and returns a list of strings.
-
-### getString
-
-**Signature:** `getString() : String`
-
-The method reads the whole input stream as one string and returns it.
-
-### read
-
-**Signature:** `read() : String`
-
-Reads a single character from the stream.
-
-### read
-
-**Signature:** `read(length : Number) : String`
-
-Reads multiple characters from the stream as string.
-
-### readLine
-
-**Signature:** `readLine() : String`
-
-Reads the next line.
-
-### readLines
-
-**Signature:** `readLines() : List`
-
-The method reads the whole input stream, parses it and returns a list of strings.
-
-### readN
-
-**Signature:** `readN(n : Number) : String`
-
-Reads n characters from the stream as string.
-
-### readString
-
-**Signature:** `readString() : String`
-
-The method reads the whole input stream as one string and returns it.
-
-### ready
-
-**Signature:** `ready() : boolean`
-
-Identifies if this stream is ready to be read.
-
-### skip
-
-**Signature:** `skip(n : Number) : void`
-
-Skips the specified number of characters in the stream.
-
-## Constructor Detail
-
-## Method Detail
-
-## Method Details
-
-### close
-
-**Signature:** `close() : void`
-
-**Description:** Closes the reader.
-
----
-
-### getLines
-
-**Signature:** `getLines() : List`
-
-**Description:** The method reads the whole input stream, parses it and returns a list of strings. Using this method on large feeds is inherently unsafe and may lead to an out-of-memory condition. Instead use method readLine() and process one line at a time.
-
-**Deprecated:**
-
-Use readLines()
-
-**Returns:**
-
-a list of strings
-
----
-
-### getString
-
-**Signature:** `getString() : String`
-
-**Description:** The method reads the whole input stream as one string and returns it. Using this method is unsafe if the length of the input stream is not known and may lead to an out-of-memory condition. Instead use method readN(Number).
-
-**Deprecated:**
-
-Use readString()
-
-**Returns:**
-
-a string, which represents the whole content of the InputStream
-
-**Throws:**
-
-IOException - if something went wrong while reading from the underlying stream
-
----
-
-### read
-
-**Signature:** `read() : String`
-
-**Description:** Reads a single character from the stream. The method returns null if the end of the stream is reached.
-
-**Returns:**
-
-a single character in a string, or null if the end of the stream is reached
-
----
-
-### read
-
-**Signature:** `read(length : Number) : String`
-
-**Description:** Reads multiple characters from the stream as string. The actual number of characters that were read can be determined from the length of the returned string. If the end of the stream is reached and no more characters can be read, the method exits with an exception.
-
-**Deprecated:**
-
-use readN(Number) instead which does not throw an exception if the stream is exhausted
-
-**Parameters:**
-
-- `length`: the number of characters to read.
-
-**Returns:**
-
-a string whose length is controlled by the length parameter. The actual number of characters that were read can be determined from the length of the returned string.
-
-**Throws:**
-
-an - exception if the stream is exhausted
-
----
-
-### readLine
-
-**Signature:** `readLine() : String`
-
-**Description:** Reads the next line.
-
-**Returns:**
-
-A String containing the contents of the line, not including any line termination characters, or null if the end of the stream has been reached.
-
----
-
-### readLines
-
-**Signature:** `readLines() : List`
-
-**Description:** The method reads the whole input stream, parses it and returns a list of strings. Using this method on large feeds is inherently unsafe and may lead to an out-of-memory condition. Instead use method readLine() and process one line at a time.
-
-**Returns:**
-
-a list of strings
-
----
-
-### readN
-
-**Signature:** `readN(n : Number) : String`
-
-**Description:** Reads n characters from the stream as string. The actual number of characters that were read can be determined from the length of the returned string. If the end of the stream is reached and no more characters can be read, the method returns null.
-
-**Parameters:**
-
-- `n`: the number of characters to read
-
-**Returns:**
-
-a string whose maximum length is controlled by the n parameter, or null if the end of the stream is reached and no more characters can be read
-
----
-
-### readString
-
-**Signature:** `readString() : String`
-
-**Description:** The method reads the whole input stream as one string and returns it. Using this method is unsafe if the length of the input stream is not known and may lead to an out-of-memory condition. Instead use method readN(Number).
-
-**Returns:**
-
-a string, which represents the whole content of the InputStream
-
-**Throws:**
-
-IOException - if something went wrong while reading from the underlying stream
-
----
-
-### ready
-
-**Signature:** `ready() : boolean`
-
-**Description:** Identifies if this stream is ready to be read.
-
-**Returns:**
-
-true guarantees that the stream is ready to read without waiting for input. A false response means that the stream may or may not block to wait for input. Note that returning false does not guarantee that the next read() will block.
-
----
-
-### skip
-
-**Signature:** `skip(n : Number) : void`
-
-**Description:** Skips the specified number of characters in the stream.
-
-**Parameters:**
-
-- `n`: the number of characters to skip.
-
----