-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Moved UtilityMethods from examples repository to Core
- Loading branch information
1 parent
d095072
commit 2c28fec
Showing
1 changed file
with
175 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,175 @@ | ||
/* | ||
BeepBeep, an event stream processor | ||
Copyright (C) 2008-2021 Sylvain Hallé | ||
This program 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 3 of the License, or | ||
(at your option) any later version. | ||
This program 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 program. If not, see <http://www.gnu.org/licenses/>. | ||
*/ | ||
package ca.uqac.lif.cep; | ||
|
||
import java.util.ArrayList; | ||
import java.util.Collection; | ||
import java.util.List; | ||
import java.util.Scanner; | ||
|
||
/** | ||
* A few methods repeatedly used throughout the code repository examples. | ||
* As for {@link Doubler}, this processor was once | ||
* part of the <a href="https://liflab.github.io/beepbeep-3-examples">examples | ||
* repository</a>, and was used in a few code examples at the beginning of the | ||
* <a href="https://liflab.gitbook.io/event-stream-processing-with-beepbeep-3">book</a> | ||
* (before the {@link ca.uqac.lif.cep.functions.ApplyFunction ApplyFunction} | ||
* processor was introduced). However, people | ||
* who were simply copy-pasting the code snippets without cloning the whole | ||
* examples repository would not find this class and could not | ||
* compile the example. It was hence | ||
* <a href="https://github.com/liflab/beepbeep-3/issues/44">decided</a> to | ||
* repatriate this class into the core library to make the whole thing | ||
* smoother for beginners. | ||
* <p> | ||
* Apart from the code examples, we do not recommend that you use this class. | ||
* @author Sylvain Hallé | ||
* @since 0.10.6 | ||
*/ | ||
public abstract class UtilityMethods | ||
{ | ||
/** | ||
* Reads an integer form the standard input | ||
* @return An integer | ||
*/ | ||
public static int readInt() | ||
{ | ||
Scanner s = new Scanner(System.in); | ||
int value = s.nextInt(); | ||
s.close(); | ||
return value; | ||
} | ||
|
||
/** | ||
* Reads a line form the standard input | ||
* @return A string with the contents of the line | ||
*/ | ||
public static String readLine() | ||
{ | ||
Scanner s = new Scanner(System.in); | ||
String value = s.nextLine(); | ||
s.close(); | ||
return value; | ||
} | ||
|
||
/** | ||
* Pauses the execution of the current thread for some time | ||
* @param milliseconds The number of milliseconds to wait before | ||
* resuming the execution | ||
*/ | ||
public static void pause(long milliseconds) | ||
{ | ||
try | ||
{ | ||
Thread.sleep(milliseconds); | ||
} | ||
catch (InterruptedException e) | ||
{ | ||
// Do nothing about this exception | ||
e.printStackTrace(); | ||
} | ||
} | ||
|
||
/** | ||
* Enters an infinite loop. This is used in some example programs | ||
* where a thread is started in the background, and the main program | ||
* has to remain idle. The only way to stop this method is for the | ||
* program to be interrupted by some other external means (e.g. pressing | ||
* Ctrl+C at the console, closing a window, etc.). | ||
*/ | ||
public static void waitForever() | ||
{ | ||
while (true) | ||
{ | ||
try | ||
{ | ||
Thread.sleep(10000); | ||
} | ||
catch (InterruptedException e) | ||
{ | ||
// Do nothing | ||
} | ||
} | ||
} | ||
|
||
/** | ||
* Creates a list out of a variable number of elements | ||
* @param elements The elements to put in the list | ||
* @return The list | ||
*/ | ||
public static List<Object> createList(Object ... elements) | ||
{ | ||
List<Object> list = new ArrayList<Object>(); | ||
for (Object o : elements) | ||
{ | ||
list.add(o); | ||
} | ||
return list; | ||
} | ||
|
||
/** | ||
* Pretty-prints an object as a string. | ||
* @param o The object | ||
* @return The string rendition of the object | ||
*/ | ||
public static String print(Object o) | ||
{ | ||
if (o == null) | ||
{ | ||
return "null"; | ||
} | ||
if (o instanceof Collection<?>) | ||
{ | ||
String out = "["; | ||
for (Object e : (Collection<?>) o) | ||
{ | ||
out += print(e); | ||
} | ||
out += "]"; | ||
return out; | ||
} | ||
if (o.getClass().isArray()) | ||
{ | ||
Object[] a = (Object[]) o; | ||
String out = "["; | ||
for (int i = 0; i < a.length; i++) | ||
{ | ||
if (i > 0) | ||
{ | ||
out += ","; | ||
} | ||
out += print(a[i]); | ||
} | ||
out += "]"; | ||
return out; | ||
} | ||
return o.toString(); | ||
} | ||
|
||
/** | ||
* Prints a "BeepBeep 3" greeting on the standard output | ||
*/ | ||
public static void printGreeting() | ||
{ | ||
System.out.println(" ___ ___ ____"); | ||
System.out.println("| _ ) ___ ___ _ __| _ ) ___ ___ _ __ |__ /"); | ||
System.out.println("| _ \\/ -_) -_) '_ \\ _ \\/ -_) -_) '_ \\ |_ \\"); | ||
System.out.println("|___/\\___\\___| .__/___/\\___\\___| .__/ |___/"); | ||
System.out.println(" |_| |_|"); | ||
} | ||
} |