fs/lib/AbstractReaderWriter.js

  1. import AbstractReader from "./AbstractReader.js";
  3. /**
  4.  * Abstract resource locator implementing the general API for <b>reading and writing</b> resources
  5.  *
  6.  * @abstract
  7.  * @public
  8.  * @class
  9.  * @alias @ui5/fs/AbstractReaderWriter
  10.  * @extends @ui5/fs/AbstractReader
  11.  */
  12. class AbstractReaderWriter extends AbstractReader {
  13. 	/**
  14. 	 * The constructor.
  15. 	 *
  16. 	 * @public
  17. 	 * @param {string} name Name of the reader/writer. Typically used for tracing purposes
  18. 	 */
  19. 	constructor(name) {
  20. 		if (new.target === AbstractReaderWriter) {
  21. 			throw new TypeError("Class 'AbstractReaderWriter' is abstract");
  22. 		}
  23. 		super(name);
  24. 	}
  26. 	/*
  27. 	 * Returns the name of the reader/writer instance. This can be used for logging/tracing purposes.
  28. 	 *
  29. 	 * @returns {string} Name of the reader/writer
  30. 	 */
  31. 	getName() {
  32. 		return this._name || `<unnamed ${this.constructor.name} Reader/Writer>`;
  33. 	}
  35. 	/**
  36. 	 * Writes the content of a resource to a path.
  37. 	 *
  38. 	 * @public
  39. 	 * @param {@ui5/fs/Resource} resource Resource to write
  40. 	 * @param {object} [options]
  41. 	 * @param {boolean} [options.readOnly=false] Whether the resource content shall be written read-only
  42. 	 *						Do not use in conjunction with the <code>drain</code> option.
  43. 	 *						The written file will be used as the new source of this resources content.
  44. 	 *						Therefore the written file should not be altered by any means.
  45. 	 *						Activating this option might improve overall memory consumption.
  46. 	 * @param {boolean} [options.drain=false] Whether the resource content shall be emptied during the write process.
  47. 	 *						Do not use in conjunction with the <code>readOnly</code> option.
  48. 	 *						Activating this option might improve overall memory consumption.
  49. 	 *						This should be used in cases where this is the last access to the resource.
  50. 	 *						E.g. the final write of a resource after all processing is finished.
  51. 	 * @returns {Promise<undefined>} Promise resolving once data has been written
  52. 	 */
  53. 	write(resource, options = {drain: false, readOnly: false}) {
  54. 		return this._write(resource, options);
  55. 	}
  57. 	/**
  58. 	 * Writes the content of a resource to a path.
  59. 	 *
  60. 	 * @abstract
  61. 	 * @protected
  62. 	 * @param {@ui5/fs/Resource} resource Resource to write
  63. 	 * @param {object} [options] Write options, see above
  64. 	 * @returns {Promise<undefined>} Promise resolving once data has been written
  65. 	 */
  66. 	_write(resource, options) {
  67. 		throw new Error("Not implemented");
  68. 	}
  69. }
  71. export default AbstractReaderWriter;