PrometheusTableItem.java

/*
 * Prometheus: Application Framework
 * Copyright 2012-2026. Tony Washer
 *
 * Licensed 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 io.github.tonywasher.joceanus.prometheus.data;

import io.github.tonywasher.joceanus.metis.data.MetisDataItem.MetisDataDeletableItem;
import io.github.tonywasher.joceanus.metis.data.MetisDataItem.MetisDataList;
import io.github.tonywasher.joceanus.metis.field.MetisFieldItem.MetisFieldTableItem;
import io.github.tonywasher.joceanus.metis.field.MetisFieldItem.MetisFieldUpdatableItem;

/**
 * Table Item interface.
 */
public interface PrometheusTableItem
        extends MetisFieldTableItem, MetisDataDeletableItem, MetisFieldUpdatableItem {
    /**
     * Is this a header?
     *
     * @return true/false
     */
    default boolean isHeader() {
        return false;
    }

    /**
     * Table List interface.
     *
     * @param <T> the item type
     */
    interface PrometheusTableList<T extends PrometheusTableItem> extends MetisDataList<T> {
        /**
         * Is the list is Locked.
         *
         * @return <code>true/false</code>
         */
        default boolean isLocked() {
            return false;
        }

        /**
         * Obtain the class of objects in this sorted.
         *
         * @return the class
         */
        Class<T> getBaseClass();

        /**
         * Obtain the item at the specified position in the list.
         *
         * @param pIndex the index of the item
         * @return the item
         */
        default T get(final int pIndex) {
            return getUnderlyingList().get(pIndex);
        }

        /**
         * Obtain the index of the item in the list.
         *
         * @param pItem the item to find
         * @return the index or -1 if the item is not in the list
         */
        default int indexOf(final Object pItem) {
            return getUnderlyingList().indexOf(pItem);
        }
    }
}