@sitevision/api 1.0.20 → 1.1.0-alpha.1

package/hidden/javax/jcr/Value/index.d.ts

@@ -0,0 +1,190 @@
+import Binary from "../Binary";
+
+/**
+ * A generic holder for the value of a property. A <code>Value</code> object can
+ * be used without knowing the actual property type (<code>STRING</code>,
+ * <code>DOUBLE</code>, <code>BINARY</code> etc.).
+ * <p>
+ * The <code>Binary</code> interface and its related methods in
+ * <code>Property</code>, <code>Value</code> and <code>ValueFactory</code>
+ * replace the deprecated <code>Value.getStream</code> and
+ * <code>Property.getStream</code> methods from JCR 1.0. However, though
+ * <code>getStream</code> has been deprecated, for reasons of backward
+ * compatibility its behavior must still conform to the following rules: <ul>
+ * <li> A <code>Value</code> object can be read using type-specific
+ * <code>get</code> methods. These methods are divided into two groups: <ul>
+ * <li> The non-stream <code>get</code> methods <code>getString()</code>,
+ * <code>getBinary()</code>, <code>getDate()</code>, <code>getDecimal()</code>,
+ * <code>getLong()</code>, <code>getDouble()</code> and
+ * <code>getBoolean()</code>. </li> <li> <code>getStream()</code>. </li> </ul>
+ * </li> <li> Once a <code>Value</code> object has been read once using
+ * <code>getStream()</code>, all subsequent calls to <code>getStream()</code>
+ * will return the same <code>Stream</code> object. This may mean, for example,
+ * that the stream returned is fully or partially consumed. In order to get a
+ * fresh stream the <code>Value</code> object must be reacquired via {@link
+ * Property#getValue()} or {@link Property#getValues()}. </li> <li> Once a
+ * <code>Value</code> object has been read once using <code>getStream()</code>,
+ * any subsequent call to any of the non-stream <code>get</code> methods will
+ * throw an <code>IllegalStateException</code>. In order to successfully invoke
+ * a non-stream <code>get</code> method, the <code>Value</code> must be
+ * reacquired via {@link Property#getValue()} or {@link Property#getValues()}.
+ * </li> <li> Once a <code>Value</code> object has been read once using a
+ * non-stream get method, any subsequent call to <code>getStream()</code> will
+ * throw an <code>IllegalStateException</code>. In order to successfully invoke
+ * <code>getStream()</code>, the <code>Value</code> must be reacquired via
+ * {@link Property#getValue()} or {@link Property#getValues()}. </ul>
+ * <p>
+ * Two <code>Value</code> instances, <code>v1</code> and <code>v2</code>, are
+ * considered equal if and only if: <ul> <li><code>v1.getType() ==
+ * v2.getType()</code>, and,</li> <li><code>v1.getString().equals(v2.getString())</code></li>
+ * </ul> Actually comparing two <code>Value</code> instances by converting them
+ * to string form may not be practical in some cases (for example, if the values
+ * are very large binaries). Consequently, the above is intended as a normative
+ * definition of <code>Value</code> equality but not as a procedural test of
+ * equality. It is assumed that implementations will have efficient means of
+ * determining equality that conform with the above definition.
+ * <p>
+ * An implementation is only required to support equality comparisons on
+ * <code>Value</code> instances that were acquired from the same
+ * <code>Session</code> and whose contents have not been read. The equality
+ * comparison must not change the state of the <code>Value</code> instances even
+ * though the <code>getString()</code> method in the above definition implies a
+ * state change.Returns a <code>String</code> representation of this value.Returns an <code>InputStream</code> representation of this value. Uses
+ * the standard conversion to binary (see JCR specification).
+ * <p>
+ * It is the responsibility of the caller to close the returned
+ * <code>InputStream</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Returns a <code>Binary</code> representation of this value. The {@link
+ * Binary} object in turn provides methods to access the binary data itself.
+ * Uses the standard conversion to binary (see JCR specification).
+ *
+ * <p><strong>Sitevision note:</strong> Limited to the <code>URL</code> and <code>URI</code> properties of nodes with primary
+ * {@link javax.jcr.nodetype.NodeType} <code>sv:file</code> and <code>sv:image</code> and to any {@link javax.jcr.PropertyType#WEAKREFERENCE}
+ * pointing to a <code>Node</code> of type <code>sv:file</code> or <code>sv:image</code></p>Returns a <code>long</code> representation of this value.Returns a <code>double</code> representation of this value.Returns a <code>BigDecimal</code> representation of this value.Returns a <code>Calendar</code> representation of this value.
+ * <p>
+ * The object returned is a copy of the stored value, so changes to it are
+ * not reflected in internal storage.Returns a <code>Boolean</code> representation of this value.Returns the <code>type</code> of this <code>Value</code>. One of: <ul>
+ * <li><code>PropertyType.STRING</code></li>
+ * <li><code>PropertyType.DATE</code></li>
+ * <li><code>PropertyType.BINARY</code></li>
+ * <li><code>PropertyType.DOUBLE</code></li>
+ * <li><code>PropertyType.DECIMAL</code></li>
+ * <li><code>PropertyType.LONG</code></li>
+ * <li><code>PropertyType.BOOLEAN</code></li>
+ * <li><code>PropertyType.NAME</code></li>
+ * <li><code>PropertyType.PATH</code></li>
+ * <li><code>PropertyType.REFERENCE</code></li>
+ * <li><code>PropertyType.WEAKREFERENCE</code></li>
+ * <li><code>PropertyType.URI</code></li></ul> See <code>{@link
+ * PropertyType}</code>.
+ * <p>
+ * The type returned is that which was set at property creation.
+  
+    */
+interface Value {
+  /**
+   * Returns a <code>String</code> representation of this value.
+   * @return A <code>String</code> representation of the value of this property.
+   * @throws ValueFormatException if conversion to a <code>String</code> is not possible.
+   * @throws IllegalStateException if <code>getStream</code> has previously been called on this <code>Value</code> instance. In this case a new <code>Value</code> instance must be acquired in order to successfully call this method.
+   * @throws RepositoryException if another error occurs.
+   */
+  getString(): string;
+
+  /**
+   * Returns an <code>InputStream</code> representation of this value. Uses
+   * the standard conversion to binary (see JCR specification).
+   * <p>
+   * It is the responsibility of the caller to close the returned
+   * <code>InputStream</code>.
+   *
+   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+   * @return An <code>InputStream</code> representation of this value.
+   * @throws RepositoryException if an error occurs.
+   * @deprecated As of JCR 2.0, {@link #getBinary()} should be used instead.
+   */
+  getStream(): unknown;
+
+  /**
+   * Returns a <code>Binary</code> representation of this value. The {@link
+   * Binary} object in turn provides methods to access the binary data itself.
+   * Uses the standard conversion to binary (see JCR specification).
+   *
+   * <p><strong>Sitevision note:</strong> Limited to the <code>URL</code> and <code>URI</code> properties of nodes with primary
+   * {@link javax.jcr.nodetype.NodeType} <code>sv:file</code> and <code>sv:image</code> and to any {@link javax.jcr.PropertyType#WEAKREFERENCE}
+   * pointing to a <code>Node</code> of type <code>sv:file</code> or <code>sv:image</code></p>
+   * @return A <code>Binary</code> representation of this value.
+   * @throws RepositoryException if an error occurs.
+   * @since JCR 2.0
+   * @since Sitevision 3.5
+   */
+  getBinary(): Binary;
+
+  /**
+   * Returns a <code>long</code> representation of this value.
+   * @return A <code>long</code> representation of this value.
+   * @throws ValueFormatException if conversion to an <code>long</code> is not possible.
+   * @throws RepositoryException if another error occurs.
+   */
+  getLong(): number;
+
+  /**
+   * Returns a <code>double</code> representation of this value.
+   * @return A <code>double</code> representation of this value.
+   * @throws ValueFormatException if conversion to a <code>double</code> is not possible.
+   * @throws RepositoryException if another error occurs.
+   */
+  getDouble(): number;
+
+  /**
+   * Returns a <code>BigDecimal</code> representation of this value.
+   * @return A <code>BigDecimal</code> representation of this value.
+   * @throws ValueFormatException if conversion to a <code>BigDecimal</code> is not possible.
+   * @throws RepositoryException if another error occurs.
+   * @since JCR 2.0
+   */
+  getDecimal(): unknown;
+
+  /**
+   * Returns a <code>Calendar</code> representation of this value.
+   * <p>
+   * The object returned is a copy of the stored value, so changes to it are
+   * not reflected in internal storage.
+   * @return A <code>Calendar</code> representation of this value.
+   * @throws ValueFormatException if conversion to a <code>Calendar</code> is not possible.
+   * @throws RepositoryException if another error occurs.
+   */
+  getDate(): unknown;
+
+  /**
+   * Returns a <code>Boolean</code> representation of this value.
+   * @return A <code>Boolean</code> representation of this value.
+   * @throws ValueFormatException if conversion to a <code>Boolean</code> is not possible.
+   * @throws RepositoryException if another error occurs.
+   */
+  getBoolean(): boolean;
+
+  /**
+   * Returns the <code>type</code> of this <code>Value</code>. One of: <ul>
+   * <li><code>PropertyType.STRING</code></li>
+   * <li><code>PropertyType.DATE</code></li>
+   * <li><code>PropertyType.BINARY</code></li>
+   * <li><code>PropertyType.DOUBLE</code></li>
+   * <li><code>PropertyType.DECIMAL</code></li>
+   * <li><code>PropertyType.LONG</code></li>
+   * <li><code>PropertyType.BOOLEAN</code></li>
+   * <li><code>PropertyType.NAME</code></li>
+   * <li><code>PropertyType.PATH</code></li>
+   * <li><code>PropertyType.REFERENCE</code></li>
+   * <li><code>PropertyType.WEAKREFERENCE</code></li>
+   * <li><code>PropertyType.URI</code></li></ul> See <code>{@link
+   * PropertyType}</code>.
+   * <p>
+   * The type returned is that which was set at property creation.
+   * @return an int
+   */
+  getType(): number;
+}
+
+export default Value;

package/hidden/javax/jcr/ValueFactory/index.d.ts

@@ -0,0 +1,179 @@
+import Value from "../Value";
+import Binary from "../Binary";
+import Node from "../Node";
+
+/**
+ * The <code>ValueFactory</code> object provides methods for the creation Value
+ * objects that can then be used to set properties.Returns a <code>Value</code> object of {@link PropertyType#STRING} with
+ * the specified <code>value</code>.Returns a <code>Value</code> object of the {@link PropertyType} specified
+ * by <code>type</code> with the specified <code>value</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Returns a <code>Value</code> object of {@link PropertyType#LONG} with the
+ * specified <code>value</code>.Returns a <code>Value</code> object of {@link PropertyType#DOUBLE} with
+ * the specified <code>value</code>.Returns a <code>Value</code> object of {@link PropertyType#DECIMAL} with
+ * the specified <code>value</code>.Returns a <code>Value</code> object of {@link PropertyType#BOOLEAN} with
+ * the specified <code>value</code>.Returns a <code>Value</code> object of {@link PropertyType#DATE} with the
+ * specified <code>value</code>.Returns a <code>Value</code> object of <code>PropertyType.BINARY</code>
+ * with a value consisting of the content of the specified
+ * <code>InputStream</code>.
+ * <p>
+ * The passed <code>InputStream</code> is closed before this method returns
+ * either normally or because of an exception.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Returns a <code>Value</code> object of <code>PropertyType.BINARY</code>
+ * with a value consisting of the content of the specified
+ * <code>Binary</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Returns a <code>Value</code> object of {@link PropertyType#REFERENCE}
+ * that holds the identifier of the specified <code>Node</code>. This
+ * <code>Value</code> object can then be used to set a property that will be
+ * a reference to that <code>Node</code>.Returns a <code>Value</code> object of {@link PropertyType#REFERENCE} (if
+ * <code>weak</code> is <code>false</code>) or {@link
+ * PropertyType#REFERENCE} (if <code>weak</code> is <code>true</code>) that
+ * holds the identifier of the specified <code>Node</code>. This
+ * <code>Value</code> object can then be used to set a property that will be
+ * a reference to that <code>Node</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Returns a <code>Binary</code> object with a value consisting of the
+ * content of the specified <code>InputStream</code>.
+ * <p>
+ * The passed <code>InputStream</code> is closed before this method returns
+ * either normally or because of an exception.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+ * @since Sitevision 3.0
+ */
+interface ValueFactory {
+  /**
+   * Returns a <code>Value</code> object of {@link PropertyType#STRING} with
+   * the specified <code>value</code>.
+   * @param value a <code>String</code>
+   * @return a <code>Value</code> of {@link PropertyType#STRING}
+   */
+  createValue(value: string): Value;
+
+  /**
+   * Returns a <code>Value</code> object of the {@link PropertyType} specified
+   * by <code>type</code> with the specified <code>value</code>.
+   *
+   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+   * @param value a <code>String</code>
+   * @param type one of the constants defined in {@link PropertyType}.
+   * @return a <code>Value</code> of {@link PropertyType} <code>type</code>.
+   * @throws ValueFormatException if the specified <code>value</code> cannot be converted to the specified <code>type</code>.
+   */
+  createValue(value: string, type: number): Value;
+
+  /**
+   * Returns a <code>Value</code> object of {@link PropertyType#LONG} with the
+   * specified <code>value</code>.
+   * @param value a <code>long</code>
+   * @return a <code>Value</code> of {@link PropertyType#LONG}
+   */
+  createValue(value: number): Value;
+
+  /**
+   * Returns a <code>Value</code> object of {@link PropertyType#DOUBLE} with
+   * the specified <code>value</code>.
+   * @param value a <code>double</code>
+   * @return a <code>Value</code> of {@link PropertyType#DOUBLE}
+   */
+  createValue(value: number): Value;
+
+  /**
+   * Returns a <code>Value</code> object of {@link PropertyType#DECIMAL} with
+   * the specified <code>value</code>.
+   * @param value a <code>double</code>
+   * @return a <code>Value</code> of {@link PropertyType#DECIMAL}
+   * @since JCR 2.0
+   */
+  createValue(value: unknown): Value;
+
+  /**
+   * Returns a <code>Value</code> object of {@link PropertyType#BOOLEAN} with
+   * the specified <code>value</code>.
+   * @param value a <code>boolean</code>
+   * @return a <code>Value</code> of {@link PropertyType#BOOLEAN}
+   */
+  createValue(value: boolean): Value;
+
+  /**
+   * Returns a <code>Value</code> object of {@link PropertyType#DATE} with the
+   * specified <code>value</code>.
+   * @param value a <code>Calendar</code>
+   * @return a <code>Value</code> of {@link PropertyType#DATE}
+   * @throws IllegalArgumentException if the specified <code>value</code> cannot be expressed in the ISO 8601-based format defined in the JCR 2.0 specification and the implementation does not support dates incompatible with that format.
+   */
+  createValue(value: unknown): Value;
+
+  /**
+   * Returns a <code>Value</code> object of <code>PropertyType.BINARY</code>
+   * with a value consisting of the content of the specified
+   * <code>InputStream</code>.
+   * <p>
+   * The passed <code>InputStream</code> is closed before this method returns
+   * either normally or because of an exception.
+   *
+   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+   * @param value an <code>InputStream</code>
+   * @return a <code>Value</code> of {@link PropertyType#BINARY}
+   * @deprecated As of JCR 2.0, {@link #createValue(Binary)} should be used instead.
+   */
+  createValue(value: unknown): Value;
+
+  /**
+   * Returns a <code>Value</code> object of <code>PropertyType.BINARY</code>
+   * with a value consisting of the content of the specified
+   * <code>Binary</code>.
+   *
+   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+   * @param value a <code>Binary</code>
+   * @return a <code>Value</code> of {@link PropertyType#BINARY}
+   * @since JCR 2.0
+   */
+  createValue(value: Binary): Value;
+
+  /**
+   * Returns a <code>Value</code> object of {@link PropertyType#REFERENCE}
+   * that holds the identifier of the specified <code>Node</code>. This
+   * <code>Value</code> object can then be used to set a property that will be
+   * a reference to that <code>Node</code>.
+   * @param value a <code>Node</code>
+   * @return a <code>Value</code> of {@link PropertyType#REFERENCE}
+   * @throws RepositoryException if the specified <code>Node</code> is not referenceable, the current <code>Session</code> is no longer active, or another error occurs.
+   */
+  createValue(value: Node): Value;
+
+  /**
+   * Returns a <code>Value</code> object of {@link PropertyType#REFERENCE} (if
+   * <code>weak</code> is <code>false</code>) or {@link
+   * PropertyType#REFERENCE} (if <code>weak</code> is <code>true</code>) that
+   * holds the identifier of the specified <code>Node</code>. This
+   * <code>Value</code> object can then be used to set a property that will be
+   * a reference to that <code>Node</code>.
+   *
+   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+   * @param value a <code>Node</code>
+   * @param weak a <code>boolean</code>. If true then a {@link PropertyType#WEAKREFERENCE} is created, otherwise a {@link PropertyType#REFERENCE} is created.
+   * @return a <code>Value</code> of {@link PropertyType#REFERENCE} or {@link PropertyType#REFERENCE}
+   * @throws RepositoryException if the specified <code>Node</code> is not referenceable, the current <code>Session</code> is no longer active, or another error occurs.
+   */
+  createValue(value: Node, weak: boolean): Value;
+
+  /**
+   * Returns a <code>Binary</code> object with a value consisting of the
+   * content of the specified <code>InputStream</code>.
+   * <p>
+   * The passed <code>InputStream</code> is closed before this method returns
+   * either normally or because of an exception.
+   *
+   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+   * @param stream an <code>InputStream</code>
+   * @return a <code>Binary</code>
+   * @throws RepositoryException if an error occurs.
+   * @since JCR 2.0
+   */
+  createBinary(stream: unknown): Binary;
+}
+
+export default ValueFactory;