core/spi/src/main/java/org/qi4j/spi/entity/NamedAssociationState.java

/*
 * Copyright (c) 2011-2013, Niclas Hedhman. All Rights Reserved.
 * Copyright (c) 2014, Paul Merlin. All Rights Reserved.
 *
 * 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 org.qi4j.spi.entity;

import org.qi4j.api.entity.EntityReference;

/**
 * State holder for NamedAssociations.
 * The actual state can be eager-loaded or lazy-loaded.
 * This is an implementation detail.
 * The Iterable<String> returns the names in the association set.
 */
public interface NamedAssociationState
    extends Iterable<String>
{
    int count();

    boolean containsName( String name );

    boolean put( String name, EntityReference entityReference );

    boolean remove( String name );

    EntityReference get( String name );

    String nameOf( EntityReference entityReference );
}