/*
* 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.brooklyn.policy.loadbalancing;
import org.apache.brooklyn.api.entity.Entity;
import org.apache.brooklyn.api.entity.Group;
import org.apache.brooklyn.api.entity.ImplementedBy;
import org.apache.brooklyn.config.ConfigKey;
import org.apache.brooklyn.core.config.BasicConfigKey;
import org.apache.brooklyn.entity.group.DynamicGroup;
import org.apache.brooklyn.util.core.flags.SetFromFlag;
import com.google.common.base.Predicate;
import com.google.common.base.Predicates;
/**
* A group of items that are contained within a given (dynamically changing) set of containers.
*
* The {@link setContainers(Group)} sets the group of containers. The membership of that group
* is dynamically tracked.
*
* When containers are added/removed, or when an items is added/removed, or when an {@link Moveable} item
* is moved then the membership of this group of items is automatically updated accordingly.
*
* For example: in Monterey, this could be used to track the actors that are within a given cluster of venues.
*/
@ImplementedBy(ItemsInContainersGroupImpl.class)
public interface ItemsInContainersGroup extends DynamicGroup {
@SetFromFlag("itemFilter")
public static final ConfigKey<Predicate<? super Entity>> ITEM_FILTER = new BasicConfigKey(
Predicate.class, "itemsInContainerGroup.itemFilter", "Filter for which items within the containers will automatically be in group", Predicates.alwaysTrue());
public void setContainers(Group containerGroup);
}