1 /*
2 * Copyright (c) 2002-2017, Mairie de Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.plugins.chat.business;
35
36 import java.util.Enumeration;
37 import java.util.Hashtable;
38
39
40 /**
41 * This class provides methods for the management of the rooms list
42 */
43 public class RoomList
44 {
45 private Hashtable _chatRooms = new Hashtable( );
46
47 /**
48 * Add a room in the list
49 *
50 * @param room The chat room to add
51 */
52 public void addRoom( ChatRoom room )
53 {
54 _chatRooms.put( room.getName( ), room );
55 }
56
57 /**
58 * Returns the chat room of the list whose name is the one specified in parameter
59 *
60 * @param strName The name of the room to get in the list
61 * @return The ChatRoom object
62 */
63 public ChatRoom getRoom( String strName )
64 {
65 return (ChatRoom) _chatRooms.get( strName );
66 }
67
68 /**
69 * Returns the list of the Rooms
70 *
71 * @return The list of the rooms
72 */
73 public Enumeration getRooms( )
74 {
75 return _chatRooms.elements( );
76 }
77
78 /**
79 * Remove rooms in the list
80 *
81 * @param rooms An array of rooms to remove in the list
82 */
83 public void removeRooms( String[] rooms )
84 {
85 for ( int i = 0; i < rooms.length; i++ )
86 {
87 _chatRooms.remove( rooms[i] );
88 }
89 }
90 }