package com.oreilly.jent.annotation.j2se;

/**
 * In general, you may use the code in this book in your programs and 
 * documentation. You do not need to contact us for permission unless 
 * you're reproducing a significant portion of the code. For example, 
 * writing a program that uses several chunks of code from this book does 
 * not require permission. Selling or distributing a CD-ROM of examples 
 * from O'Reilly books does require permission. Answering a question by 
 * citing this book and quoting example code does not require permission. 
 * Incorporating a significant amount of example code from this book into 
 * your product's documentation does require permission.
 * 
 * We appreciate, but do not require, attribution. An attribution usually 
 * includes the title, author, publisher, and ISBN. For example: 
 * 
 *   "Java Enterprise in a Nutshell, Third Edition, 
 *    by Jim Farley and William Crawford 
 *    with Prakash Malani, John G. Norman, and Justin Gehtland. 
 *    Copyright 2006 O'Reilly Media, Inc., 0-596-10142-2."
 *  
 *  If you feel your use of code examples falls outside fair use or the 
 *  permission given above, feel free to contact us at 
 *  permissions@oreilly.com.
 */

import javax.naming.Context;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Learn1
@Learn2("This servlet demonstrates the use of the XYZ design pattern.")
public class CourseExample extends HttpServlet {
    @Learn1
    @Learn2("As discussed in lesson 4, the use of the Context member" +
            " is meant to simplify the rest of the servlet code")
    @Learn3(value="As discussed in lesson 4, the use of the Context member" +
                  " is meant to simplify the rest of the servlet code",
            moduleId="1")
    private Context mCtx = null;

    @Learn1
    @Learn2("This no-argument constructor will become interesting in module 3")
    @Learn3(value="This no-argument constructor is used in our Cactus tests",
            moduleId="3",
            moduleOnly=true)
    public CourseExample() {
        super();
    }
    
    @Learn1
    @Learn3(value="Examine this method to see the \"keep it simple\" principles "
                  + "discussed in module 2.",
            moduleId="2")
    private String doSomethingInteresting() {
        return "a string";
    }
    
    private void thisMethodHasNoInstructionalValue() {
    }
    
    @Learn1
    @Learn2("Notice that we have a doPost(), but no doGet()")
    public void doPost(HttpServletRequest request, HttpServletResponse response) {
        
    }
}
