View Javadoc

1   /*
2    * LetterBox.java Created @ Feb 27, 2004
3    * 
4    * Copyright (c) 2003-2005 Delft University of Technology, Jaffalaan 5, 2628 BX
5    * Delft, the Netherlands. All rights reserved.
6    * 
7    * See for project information <a href="http://www.simulation.tudelft.nl/">
8    * www.simulation.tudelft.nl </a>.
9    * 
10   * The source code and binary code of this software is proprietary information
11   * of Delft University of Technology.
12   */
13  
14  package nl.tudelft.simulation.messaging.devices.reference;
15  
16  import nl.tudelft.simulation.messaging.comparators.FiFo;
17  import nl.tudelft.simulation.messaging.devices.components.ReceivingDevice;
18  import nl.tudelft.simulation.messaging.devices.types.DeviceType;
19  import nl.tudelft.simulation.messaging.queues.MessageQueue;
20  
21  /***
22   * A reference implementation of receiving regular mail. <br>
23   * <br>
24   * Copyright (c) 2003-2005 Delft University of Technology, Jaffalaan 5, 2628 BX
25   * Delft, the Netherlands. All rights reserved.
26   * 
27   * See for project information <a href="http://www.simulation.tudelft.nl/">
28   * www.simulation.tudelft.nl </a>.
29   * 
30   * The source code and binary code of this software is proprietary information
31   * of Delft University of Technology.
32   * 
33   * @author <a href="http://www.tbm.tudelft.nl/webstaf/peterja/index.htm">Peter
34   *         Jacobs </a>, <a
35   *         href="mailto:s.p.a.vanhouten@tbm.tudelft.nl">Stijn-Pieter van Houten
36   *         </a>, <a
37   *         href="http://www.tbm.tudelft.nl/webstaf/alexandv/index.htm">Alexander
38   *         Verbraeck </a>
39   * @version $$Revision: 1.3 $$ $$Date: 2005/04/08 11:29:12 $$
40   */
41  public class LetterBox extends ReceivingDevice
42  {
43  	/*** the serial version uid */
44  	private static final long serialVersionUID = 12L;
45  
46  	/*** default name for the inbox * */
47  	private static final String DEFAULT_NAME = "Letter-box";
48  
49  	/***
50  	 * Constructs a new LetterBox with the default name "Letter-box". A
51  	 * LetterBox is used for receiving letters.
52  	 */
53  	public LetterBox()
54  	{
55  		this(LetterBox.DEFAULT_NAME);
56  	}
57  
58  	/***
59  	 * Constructs a new LetterBox. A LetterBox is used for receiving letters.
60  	 * 
61  	 * @param name the name of the LetterBox
62  	 */
63  	public LetterBox(final String name)
64  	{
65  		super(name, DeviceType.LETTER, new MessageQueue(new FiFo()));
66  	}
67  }