Filter CSS class names, “~” is not a valid character.

[Sone.git] / src / main / java / net / pterodactylus / sone / template / CssClassNameFilter.java

diff --git a/src/main/java/net/pterodactylus/sone/template/CssClassNameFilter.java b/src/main/java/net/pterodactylus/sone/template/CssClassNameFilter.java
new file mode 100644 (file)
index 0000000..6ba5d6b
--- /dev/null
+++ b/src/main/java/net/pterodactylus/sone/template/CssClassNameFilter.java
@@ -0,0 +1,42 @@
+/*
+ * Sone - CssClassNameFilter.java - Copyright © 2010 David Roden
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package net.pterodactylus.sone.template;
+
+import java.util.Map;
+
+import net.pterodactylus.util.template.DataProvider;
+import net.pterodactylus.util.template.Filter;
+
+/**
+ * Converts the {@link String} {@link String#valueOf(Object) representation} of
+ * an object to a valid CSS class name by converting all characters that are not
+ * US-ASCII letters or numbers to an underscore.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+public class CssClassNameFilter implements Filter {
+
+       /**
+        * {@inheritDoc}
+        */
+       @Override
+       public Object format(DataProvider dataProvider, Object data, Map<String, String> parameters) {
+               return String.valueOf(data).replaceAll("[^a-zA-Z0-9-]", "_");
+       }
+
+}