core/api/src/main/java/org/apache/polygene/api/association/AssociationStateHolder.java

/*
 *  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.polygene.api.association;

import java.lang.reflect.AccessibleObject;
import java.util.stream.Stream;
import org.apache.polygene.api.property.StateHolder;

/**
 * This represents the state of a entity (properties+associations).
 */
public interface AssociationStateHolder extends StateHolder
{
    /**
     * Get an association for a specific accessor method.
     *
     * @param <T> Association type
     * @param associationMethod for the association
     *
     * @return the association
     */
    <T> Association<T> associationFor( AccessibleObject associationMethod );

    /**
     * Get all associations.
     *
     * @return stream of associations
     */
    Stream<? extends Association<?>> allAssociations();

    /**
     * Get a many-association for a specific accessor method.
     *
     * @param <T> Association type
     * @param manyassociationMethod for the many-association
     *
     * @return the association
     */
    <T> ManyAssociation<T> manyAssociationFor( AccessibleObject manyassociationMethod );

    /**
     * Get all ManyAssociations.
     *
     * @return stream of many-associations
     */
    Stream<? extends ManyAssociation<?>> allManyAssociations();

    /**
     * Get a named-association for a specific accessor method.
     *
     * @param <T> Association type
     * @param namedassociationMethod for the named-association
     *
     * @return the association
     */
    <T> NamedAssociation<T> namedAssociationFor( AccessibleObject namedassociationMethod );

    /**
     * Get all named-associations.
     *
     * @return stream of named-associations
     */
    Stream<? extends NamedAssociation<?>> allNamedAssociations();
}