com.gemstone.gemfire.cache.query.CqAttributesMutator Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation

SnappyData store based off Pivotal GemFireXD

The newest version!

/*
 * Copyright (c) 2010-2015 Pivotal Software, Inc. 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. See accompanying
 * LICENSE file.
 */

package com.gemstone.gemfire.cache.query;

/**
 * This interface is used to modify the listeners that are associated with a CQ. 
 * Each CqQuery has an CqAttributesMutator interface which supports modification 
 * of certain CQ attributes after the CQ has been created. 
 * 
 * @author anil 
 * @since 5.5
 */
public interface CqAttributesMutator {
  
  /**
   * Adds a CQ listener to the end of the list of CQ listeners on this CqQuery.
   * @param aListener the user defined CQ listener to add to the CqQuery.
   * @throws IllegalArgumentException if aListener is null
   */
  public void addCqListener(CqListener aListener);
  
  /**
   * Removes given CQ listener from the list of CQ listeners on this CqQuery.
   * Does nothing if the specified listener has not been added.
   * If the specified listener has been added then will
   * be called on it; otherwise does nothing.
   * @param aListener the CQ listener to remove from the CqQuery.
   * @throws IllegalArgumentException if aListener is null
   */
  public void removeCqListener(CqListener aListener);
  
  /**
   * Adds the given set CqListner on this CQ. If the CQ already has CqListeners, this 
   * removes those old CQs and initializes with the newListeners.
   * @param newListeners a possibly null or empty array of listeners to add 
   * to this CqQuery.
   * @throws IllegalArgumentException if the newListeners array 
   * has a null element
   */
  public void initCqListeners(CqListener[] newListeners);
  
}