KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > lib > cvsclient > event > BinaryMessageEvent


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.lib.cvsclient.event;
21
22 /**
23  * An event sent from the server to indicate that a binary message should be
24  * displayed to the user.
25  * <p>
26  * One protocol reponse mey be splitted into several messages.
27  *
28  * @author Martin Entlicher
29  */
30 public class BinaryMessageEvent extends CVSEvent {
31     /**
32      * Holds value of property message.
33      */
34     private byte[] message;
35
36     private int len;
37
38     /**
39      * Construct a MessageEvent
40      * @param source the source of the event
41      * @param message the message text
42      */
43     public BinaryMessageEvent(Object JavaDoc source, byte[] message, int len) {
44         super(source);
45         this.message = message;
46         this.len = len;
47     }
48
49     /**
50      * Raw data buffer that holds binary data.
51      * @return raw data buffer, its {@link #getMessageLength()} subset represents actual data
52      */
53     public byte[] getMessage() {
54         return message;
55     }
56
57     /**
58      * Defines valid data length in raw data buffer.
59      * @return number of valid bytes in message raw data buffer.
60      */
61     public int getMessageLength() {
62         return len;
63     }
64
65     /**
66      * Fire the event to the event listener. Subclasses should call the
67      * appropriate method on the listener to dispatch this event.
68      * @param listener the event listener
69      */
70     protected void fireEvent(CVSListener listener) {
71         listener.messageSent(this);
72     }
73
74 }
Popular Tags