/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common
* Development and Distribution License("CDDL") (collectively, the
* "License"). You may not use this file except in compliance with the
* License. You can obtain a copy of the License at
* http://www.netbeans.org/cddl-gplv2.html
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
* specific language governing permissions and limitations under the
* License. When distributing the software, include this License Header
* Notice in each file and include the License file at
* nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the
* License Header, with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Contributor(s):
*
* The Original Software is NetBeans. The Initial Developer of the Original
* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
* Microsystems, Inc. All Rights Reserved.
*
* If you wish your version of this file to be governed by only the CDDL
* or only the GPL Version 2, indicate your decision by adding
* "[Contributor] elects to include this software in this distribution
* under the [CDDL or GPL Version 2] license." If you do not indicate a
* single choice of license, a recipient has the option to distribute
* your version of this file under either the CDDL, the GPL Version 2 or
* to extend the choice of license to its licensees as provided above.
* However, if you add GPL Version 2 code and therefore, elected the GPL
* Version 2 license, then the option applies only if the new code is
* made subject to such option by the copyright holder.
*/
package org.netbeans.lib.cvsclient.event;
/**
* An event sent from the server to indicate that a binary message should be
* displayed to the user.
* <p>
* One protocol reponse mey be splitted into several messages.
*
* @author Martin Entlicher
*/
public class BinaryMessageEvent extends CVSEvent {
/**
* Holds value of property message.
*/
private byte[] message;
private int len;
/**
* Construct a MessageEvent
* @param source the source of the event
* @param message the message text
*/
public BinaryMessageEvent(Object source, byte[] message, int len) {
super(source);
this.message = message;
this.len = len;
}
/**
* Raw data buffer that holds binary data.
* @return raw data buffer, its {@link #getMessageLength()} subset represents actual data
*/
public byte[] getMessage() {
return message;
}
/**
* Defines valid data length in raw data buffer.
* @return number of valid bytes in message raw data buffer.
*/
public int getMessageLength() {
return len;
}
/**
* Fire the event to the event listener. Subclasses should call the
* appropriate method on the listener to dispatch this event.
* @param listener the event listener
*/
protected void fireEvent(CVSListener listener) {
listener.messageSent(this);
}
}
|