| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You under the Apache License, Version 2.0 |
| * (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.apache.jackrabbit.oak.api; |
| |
| import org.jetbrains.annotations.NotNull; |
| |
| /** |
| * Immutable property value. |
| * A value is either an atom or an array of atoms. |
| * |
| */ |
| public interface PropertyValue extends Comparable<PropertyValue> { |
| |
| /** |
| * Determine whether the value is an array of atoms |
| * @return {@code true} if and only if the value is an array of atoms. |
| */ |
| boolean isArray(); |
| |
| /** |
| * Determine the type of this value |
| * @return the type of this value |
| */ |
| Type<?> getType(); |
| |
| /** |
| * Value of this object. |
| * The type of the return value is determined by the target {@code type} |
| * argument. If {@code type.isArray()} is true, this method returns an |
| * {@code Iterable} of the {@link Type#getBaseType() base type} of |
| * {@code type} containing all values of this property. |
| * If the target type is not the same as the type of this property an attempt |
| * is made to convert the value to the target type. If the conversion fails an |
| * exception is thrown. |
| * @param type target type |
| * @param <T> |
| * @return the value of this property |
| * @throws IllegalStateException if {@code type.isArray() == false} and |
| * {@code this.isArray() == true}. In other words, when trying to convert |
| * from an array to an atom. |
| * @throws IllegalArgumentException if {@code type} refers to an unknown type. |
| * @throws NumberFormatException if conversion to a number failed. |
| * @throws UnsupportedOperationException if conversion to boolean failed. |
| */ |
| @NotNull |
| <T> T getValue(Type<T> type); |
| |
| /** |
| * Value at the given {@code index}. |
| * The type of the return value is determined by the target {@code type} |
| * argument. |
| * If the target type is not the same as the type of this property an attempt |
| * is made to convert the value to the target type. If the conversion fails an |
| * exception is thrown. |
| * @param type target type |
| * @param index |
| * @param <T> |
| * @return the value of this object at the given {@code index} |
| * @throws IndexOutOfBoundsException if {@code index} is less than {@code 0} or |
| * greater or equals {@code count()}. |
| * @throws IllegalArgumentException if {@code type} refers to an unknown type or if |
| * {@code type.isArray()} is true. |
| */ |
| @NotNull |
| <T> T getValue(Type<T> type, int index); |
| |
| /** |
| * The size of the value of this object. |
| * @return size of the value of this property |
| * @throws IllegalStateException if the value is an array |
| */ |
| long size(); |
| |
| /** |
| * The size of the value at the given {@code index}. |
| * @param index |
| * @return size of the value at the given {@code index}. |
| * @throws IndexOutOfBoundsException if {@code index} is less than {@code 0} or |
| * greater or equals {@code count()}. |
| */ |
| long size(int index); |
| |
| /** |
| * The number of values of this object. {@code 1} for atoms. |
| * @return number of values |
| */ |
| int count(); |
| |
| } |