sfcc-dev-mcp 1.0.0

package/docs/dw_io/StringWriter.md

@@ -0,0 +1,81 @@
+## Package: dw.io
+
+# Class StringWriter
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.io.Writer
+  - dw.io.StringWriter
+
+## Description
+
+A Writer that can be used to generate a String. In most cases it is not necessary to use StringWriter. If the final destination of the output is a file, use FileWriter directly. This will help to reduce memory usage. If you wish to transfer a feed to a remote FTP, SFTP or WebDAV server, first write the feed to the file system using FileWriter and optionally CSVStreamWriter or XMLStreamWriter, then upload the file with FTPClient.putBinary(String, File), SFTPClient.putBinary(String, File), or WebDAVClient.put(String, File). Note: when this class is used with sensitive data, be careful in persisting sensitive information to disk.
+
+## Constructor Summary
+
+StringWriter() Creates a new StringWriter.
+
+## Method Summary
+
+### toString
+
+**Signature:** `toString() : String`
+
+Returns a string representation of this writer.
+
+### write
+
+**Signature:** `write(str : String) : void`
+
+Write the given string to the stream.
+
+### write
+
+**Signature:** `write(str : String, off : Number, len : Number) : void`
+
+Write the given string to the stream.
+
+## Constructor Detail
+
+## Method Detail
+
+## Method Details
+
+### toString
+
+**Signature:** `toString() : String`
+
+**Description:** Returns a string representation of this writer.
+
+**Returns:**
+
+a string representation of this writer.
+
+---
+
+### write
+
+**Signature:** `write(str : String) : void`
+
+**Description:** Write the given string to the stream.
+
+**Parameters:**
+
+- `str`: the string to write to the stream.
+
+---
+
+### write
+
+**Signature:** `write(str : String, off : Number, len : Number) : void`
+
+**Description:** Write the given string to the stream.
+
+**Parameters:**
+
+- `str`: the string to write to the stream.
+- `off`: the offset from which to start writing characters to the stream.
+- `len`: the number of characters to write from the stream.
+
+---

package/docs/dw_io/Writer.md

@@ -0,0 +1,92 @@
+## Package: dw.io
+
+# Class Writer
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.io.Writer
+
+## Description
+
+The class supports writing characters to a stream. Note: when this class is used with sensitive data, be careful in persisting sensitive information to disk.
+
+## Constructor Summary
+
+Writer(stream : OutputStream) Create a writer from a stream using UTF-8 character encoding.
+
+Writer(stream : OutputStream, encoding : String) Create a writer from a stream using the specified character encoding.
+
+## Method Summary
+
+### close
+
+**Signature:** `close() : void`
+
+Closes the writer.
+
+### flush
+
+**Signature:** `flush() : void`
+
+Flushes the buffer.
+
+### write
+
+**Signature:** `write(str : String) : void`
+
+Write the given string to the stream.
+
+### write
+
+**Signature:** `write(str : String, off : Number, len : Number) : void`
+
+Write the given string to the stream.
+
+## Constructor Detail
+
+## Method Detail
+
+## Method Details
+
+### close
+
+**Signature:** `close() : void`
+
+**Description:** Closes the writer.
+
+---
+
+### flush
+
+**Signature:** `flush() : void`
+
+**Description:** Flushes the buffer.
+
+---
+
+### write
+
+**Signature:** `write(str : String) : void`
+
+**Description:** Write the given string to the stream.
+
+**Parameters:**
+
+- `str`: the string to write to the stream.
+
+---
+
+### write
+
+**Signature:** `write(str : String, off : Number, len : Number) : void`
+
+**Description:** Write the given string to the stream.
+
+**Parameters:**
+
+- `str`: the string to write to the stream.
+- `off`: the offset from which to start writing characters to the stream.
+- `len`: the number of characters to write from the stream.
+
+---

package/docs/dw_io/XMLIndentingStreamWriter.md

@@ -0,0 +1,112 @@
+## Package: dw.io
+
+# Class XMLIndentingStreamWriter
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.io.XMLStreamWriter
+  - dw.io.XMLIndentingStreamWriter
+
+## Description
+
+A XMLIndentingStreamWriter writes the XML output formatted for good readability. Note: when this class is used with sensitive data, be careful in persisting sensitive information to disk.
+
+## Properties
+
+### indent
+
+**Type:** String
+
+The indent.
+
+### newLine
+
+**Type:** String
+
+The string that is used for a new line character. The
+ default is the normal new line character.
+
+## Constructor Summary
+
+XMLIndentingStreamWriter(writer : Writer) Constructs the writer for the specified writer.
+
+## Method Summary
+
+### getIndent
+
+**Signature:** `getIndent() : String`
+
+Returns the indent.
+
+### getNewLine
+
+**Signature:** `getNewLine() : String`
+
+Returns the string that is used for a new line character.
+
+### setIndent
+
+**Signature:** `setIndent(indent : String) : void`
+
+Specifies a string that will be used as identing characters.
+
+### setNewLine
+
+**Signature:** `setNewLine(newLine : String) : void`
+
+Sets the string that is used for a new line character.
+
+## Constructor Detail
+
+## Method Detail
+
+## Method Details
+
+### getIndent
+
+**Signature:** `getIndent() : String`
+
+**Description:** Returns the indent.
+
+**Returns:**
+
+Returns the indent.
+
+---
+
+### getNewLine
+
+**Signature:** `getNewLine() : String`
+
+**Description:** Returns the string that is used for a new line character. The default is the normal new line character.
+
+**Returns:**
+
+the new line.
+
+---
+
+### setIndent
+
+**Signature:** `setIndent(indent : String) : void`
+
+**Description:** Specifies a string that will be used as identing characters. The default are two space characters.
+
+**Parameters:**
+
+- `indent`: The indent to set.
+
+---
+
+### setNewLine
+
+**Signature:** `setNewLine(newLine : String) : void`
+
+**Description:** Sets the string that is used for a new line character.
+
+**Parameters:**
+
+- `newLine`: The newLine to set.
+
+---

package/docs/dw_io/XMLStreamConstants.md

@@ -0,0 +1,24 @@
+## Package: dw.io
+
+# Class XMLStreamConstants
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.io.XMLStreamConstants
+
+## Description
+
+Useful constants for working with XML streams.
+
+## Constants
+
+## Properties
+
+## Constructor Summary
+
+XMLStreamConstants()
+
+## Method Summary
+
+## Constructor Detail