org.xlightweb.InvokeOn Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xlightweb

xLightweb is a lightweight, high performance, scalable web network library

There is a newer version: 2.13.2

/*
 *  Copyright (c) xlightweb.org, 2008 - 2010. All rights reserved.
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Please refer to the LGPL license at: http://www.gnu.org/copyleft/lesser.txt
 * The latest copy of this software may be found on http://www.xlightweb.org/
 */
package org.xlightweb;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;





/**
 * Annotation which defines when a call back method will be call. Either by 
 * receiving a message header (default) or by receiving the complete message. 
 * This annotation can be used to declare the invoke modus by performing 
 * call back method such as onRequest or onResponse. 
 * For these call back method xLightweb is free to invoke the method on MessageRecevied 
 * even though on HeaderReceived is declared. 
 * 
 * E.g.
 *  *   class MyResponseHandler implements IHttpResponseHandler {
 *   
 *      @InvokeOn(InvokeOn.MESSAGE_RECEIVED)   // overrides default HEADER_RECEIVED
 *      public void onResponse(IHttpResponse response) throws IOException {
 *        status = response.getStatus();
 *        //...
 *      }
 *     
 *      public void void onException(IOException ioe) {
 *         //...
 *      }
 *
 *      //...      
 *   }
 *   
 * 
 * 
 * @author [email protected]
 */
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface InvokeOn {
	
	public static final int HEADER_RECEIVED = 0;
	public static final int MESSAGE_RECEIVED = 1;
	
	int value() default HEADER_RECEIVED;
}