1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20 package org.apache.commons.pipeline.event;
21
22 import java.util.EventObject;
23
24 /**
25 * This event is used to signal the availability of the specified key. This is
26 * usually used for inter-branch synchronization using the
27 * {@link org.apache.commons.pipeline.stage.RaiseKeyAvailableEventStage RaiseKeyAvailableEventStage}
28 * and/or the {@link org.apache.commons.pipeline.stage.KeyWaitBufferStage KeyWaitBufferStage}.
29 */
30 public class KeyAvailableEvent<T> extends EventObject {
31 /**
32 *
33 */
34 private static final long serialVersionUID = -7704631412431162164L;
35 private T key;
36
37 /** Creates a new instance of KeyAvailableEvent */
38 public KeyAvailableEvent(Object source, T key) {
39 super(source);
40 this.key = key;
41 }
42
43 /**
44 * Returns the key.
45 */
46 public T getKey() {
47 return this.key;
48 }
49 }