1 /* 2 * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * - Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 11 * - Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * - Neither the name of Oracle nor the names of its 16 * contributors may be used to endorse or promote products derived 17 * from this software without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS 20 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 21 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 24 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 25 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 26 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 27 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 28 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 /* 33 * This source code is provided to illustrate the usage of a given feature 34 * or technique and has been deliberately simplified. Additional steps 35 * required for a production-quality application, such as security checks, 36 * input validation and proper error handling, might not be present in 37 * this sample code. 38 */ 39 package plugins; 40 41 import checker.Module; 42 import checker.Require; 43 44 /** 45 * BoilerPlugin provides support for boiling water and keeping water warm. 46 */ 47 @Require(value = Module.CLOCK, maxVersion = 3) 48 @Require(value = Module.THERMOMETER) 49 @Require(value = Module.HEATER) 50 @Require(value = Module.LED, optional = true) //will use if present 51 public class BoilerPlugin { 52 53 /** 54 * Heats water up to 100 degrees Celsius. 55 */ boil()56 public void boil() { 57 boil(100); 58 } 59 60 /** 61 * Heats water up to temperature. 62 * 63 * @param temperature - desired temperature of the water in the boiler 64 */ boil(int temperature)65 public void boil(int temperature) { 66 /* 67 * Turn on heater and wait while temperature reaches desired temperature 68 * in Celsius. Finally, turn off heater. 69 * If present, the LED light changes color according to the temperature. 70 */ 71 } 72 73 /** 74 * Keeps desired temperature. 75 * 76 * @param temperature - desired temperature of the water in the boiler 77 * @param seconds - period of time for checking temperature in seconds 78 */ keepWarm(int temperature, int seconds)79 public void keepWarm(int temperature, int seconds) { 80 //Every n seconds check temperature and warm up, if necessary. 81 } 82 83 } 84