All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
net.sf.aspect4log.text.LogFormatter Maven / Gradle / Ivy
/* This file is part of the aspect project.
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; version 2.1
of the License.
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, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
Copyright 2007-2014 Semochkin Vitaliy Evgenevich aka Yilativs
*/
package net.sf.aspect4log.text;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.Collection;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.commons.beanutils.PropertyUtils;
import org.apache.commons.lang3.ArrayUtils;
/**
* This class is responsible for building log blocks.
*
* @author yilativs
*
*/
public class LogFormatter {
private static final String ERROR_EVALUTTING_TO_STRING_SYMBOL = "☣";
public static final String ELEMENTS_DELITMETER = ", ";
public static final String MAP_KEY_VALUE_DELIMETER = "=";
public static final String ARRAY_BEGINS_BRACKET = "[";
public static final String ARRAY_ENDS_BRACKET = "]";
public static final String ITERABLE_BEGINS_BRACKET = "{";
public static final String ITERABLE_ENDS_BRACKET = "}";
private String elementsDelitmiter = ELEMENTS_DELITMETER;
private String mapKeyValueDelimeter = MAP_KEY_VALUE_DELIMETER;
private String arrayBeginsBracket = ARRAY_BEGINS_BRACKET;
private String arrayEndsBracket = ARRAY_ENDS_BRACKET;
private String iterableBeginsBracket = ITERABLE_BEGINS_BRACKET;
private String iterableEndsBracket = ITERABLE_ENDS_BRACKET;
private String undefindedToStringMethodSymbol;
/**
* a symbol to be shown in case exception happen during to
*/
private String errorEvaluatingToStringSymbol=ERROR_EVALUTTING_TO_STRING_SYMBOL;
private String nullSymbol;
public String getElementsDelitmiter() {
return elementsDelitmiter;
}
public void setElementsDelitmiter(String elementsDelitmiter) {
this.elementsDelitmiter = elementsDelitmiter;
}
public String getMapKeyValueDelimeter() {
return mapKeyValueDelimeter;
}
public void setMapKeyValueDelimeter(String mapKeyValueDelimeter) {
this.mapKeyValueDelimeter = mapKeyValueDelimeter;
}
public String getArrayBeginsBracket() {
return arrayBeginsBracket;
}
public void setArrayBeginsBracket(String arrayBeginsBracket) {
this.arrayBeginsBracket = arrayBeginsBracket;
}
public String getArrayEndsBracket() {
return arrayEndsBracket;
}
public void setArrayEndsBracket(String arrayEndsBracket) {
this.arrayEndsBracket = arrayEndsBracket;
}
public String getIterableBeginsBracket() {
return iterableBeginsBracket;
}
public void setIterableBeginsBracket(String iterableBeginsBracket) {
this.iterableBeginsBracket = iterableBeginsBracket;
}
public String getIterableEndsBracket() {
return iterableEndsBracket;
}
public void setIterableEndsBracket(String iterableEndsBracket) {
this.iterableEndsBracket = iterableEndsBracket;
}
public String getUndefindedToStringMethodSymbol() {
return undefindedToStringMethodSymbol;
}
public void setUndefindedToStringMethodSymbol(String undefindedToStringValue) {
this.undefindedToStringMethodSymbol = undefindedToStringValue;
}
public String getNullSymbol() {
return nullSymbol;
}
public void setNullSymbol(String nullValue) {
this.nullSymbol = nullValue;
}
public String getErrorEvaluatingToStringSymbol() {
return errorEvaluatingToStringSymbol;
}
public void setErrorEvaluatingToStringSymbol(String errorValue) {
this.errorEvaluatingToStringSymbol = errorValue;
}
private static Method OBJECT_EQUALS_METHOD_TMP = null;
static {
try {
OBJECT_EQUALS_METHOD_TMP = Object.class.getMethod("toString");
} catch (NoSuchMethodException e) {
// that's impossible
throw new ExceptionInInitializerError(e);
} catch (SecurityException e) {
// that's impossible
throw new ExceptionInInitializerError(e);
}
}
private static final Method OBJECT_EQUALS_METHOD = OBJECT_EQUALS_METHOD_TMP;
public String toString(Map map) {
StringBuilder stringBuilder = new StringBuilder();
for (Iterator iterator = map.entrySet().iterator(); iterator.hasNext();) {
Entry entry = (Entry) iterator.next();
toString(stringBuilder, entry.getKey());
stringBuilder.append(mapKeyValueDelimeter);
toString(stringBuilder, entry.getValue());
if (iterator.hasNext()) {
stringBuilder.append(elementsDelitmiter);
}
}
return stringBuilder.toString();
}
public String toString(Iterable iterable) {
// check if object overrides toString http://stackoverflow.com/questions/12133817/determining-if-a-method-overrides-another-at-runtime
// type Ø for null. for not implemented toString ¿
StringBuilder stringBuilder = new StringBuilder();
;
for (Iterator iterator = iterable.iterator(); iterator.hasNext();) {
toString(stringBuilder, iterator.next());
if (iterator.hasNext()) {
stringBuilder.append(elementsDelitmiter);
}
}
return stringBuilder.toString();
}
public String toString(Object[] array) {
StringBuilder stringBuilder = new StringBuilder();
for (int i = 0; i < array.length; i++) {
toString(stringBuilder, array[i]);
if (i < array.length - 1) {
stringBuilder.append(elementsDelitmiter);
}
}
return stringBuilder.toString();
}
public StringBuilder toString(StringBuilder stringBuilder, Object o) {
if (o != null) {
if (o instanceof Object[]) {
addArrayBrackets(stringBuilder, toString((Object[]) o));
} else if (o instanceof boolean[]) {
addArrayBrackets(stringBuilder, toString(ArrayUtils.toObject((boolean[]) o)));
} else if (o instanceof char[]) {
addArrayBrackets(stringBuilder, toString(ArrayUtils.toObject((char[]) o)));
} else if (o instanceof byte[]) {
addArrayBrackets(stringBuilder, toString(ArrayUtils.toObject((byte[]) o)));
} else if (o instanceof short[]) {
addArrayBrackets(stringBuilder, toString(ArrayUtils.toObject((short[]) o)));
} else if (o instanceof int[]) {
addArrayBrackets(stringBuilder, toString(ArrayUtils.toObject((int[]) o)));
} else if (o instanceof long[]) {
addArrayBrackets(stringBuilder, toString(ArrayUtils.toObject((long[]) o)));
} else if (o instanceof float[]) {
addArrayBrackets(stringBuilder, toString(ArrayUtils.toObject((float[]) o)));
} else if (o instanceof double[]) {
addArrayBrackets(stringBuilder, toString(ArrayUtils.toObject((double[]) o)));
} else if (o instanceof Map) {
addIterrableBrackets(stringBuilder, toString((Map) o));
} else if (o instanceof Collection) {
addIterrableBrackets(stringBuilder, toString(((Iterable) o)));
} else {
if (undefindedToStringMethodSymbol==null || isToStringOverriden(o.getClass()) ) {
try{
stringBuilder.append(o);
}catch(RuntimeException e){
addExceptionOnToStringEvaluation(stringBuilder,e.toString());
}
} else {
stringBuilder.append(undefindedToStringMethodSymbol);
}
}
} else {
stringBuilder.append(nullSymbol);
}
return stringBuilder;
}
private void addBrackets(StringBuilder stringBuilder, String beginBracket, String string, String endBracket) {
stringBuilder.append(beginBracket);
stringBuilder.append(string);
stringBuilder.append(endBracket);
}
private void addArrayBrackets(StringBuilder stringBuilder, String string) {
addBrackets(stringBuilder, arrayBeginsBracket, string, arrayEndsBracket);
}
private void addIterrableBrackets(StringBuilder stringBuilder, String string) {
addBrackets(stringBuilder, iterableBeginsBracket, string, iterableEndsBracket);
}
// @TODO consider implementing cache on WeakHashReferences (because class objects are rare to be gc's it's ok to use WeakHashReferences
// private ConcurrentMap, Boolean> classDefaultToStringOverridenMap = new ConcurrentHashMap, Boolean>();
//
// public boolean isToStringOverriden(Class clazz) {
// try {
// Boolean isDefaultToStringOverriden = classDefaultToStringOverridenMap.get(clazz);
// if (isDefaultToStringOverriden == null) {
// isDefaultToStringOverriden = !clazz.getMethod("toString").equals(OBJECT_EQUALS_METHOD);
// classDefaultToStringOverridenMap.put(clazz, isDefaultToStringOverriden);
// }
// return isDefaultToStringOverriden;
// } catch (NoSuchMethodException | SecurityException e) {
// // that's impossible
// return false;
// }
// }
public boolean isToStringOverriden(Class clazz) {
try {
return !OBJECT_EQUALS_METHOD.equals(clazz.getMethod("toString"));
} catch (NoSuchMethodException e) {
// that's impossible
return false;
} catch (SecurityException e) {
// that's impossible
return false;
}
}
// \$\{(.*)\};
private static final Pattern VARIABLE_SEARCH_PATTERN = Pattern.compile("(?!\\$\\{\\$\\{)\\$\\{(.*?)\\}");
public String toString(String template, Object object) {
if (template.isEmpty()) {
return "";
}
Matcher matcher = VARIABLE_SEARCH_PATTERN.matcher(template);
StringBuilder stringBuilder = new StringBuilder(template);
int shift = 0;
EnclosingBean bean = new EnclosingBean(object);
while (matcher.find()) {
String property = matcher.group(1);
String replacement = toString(bean, property);
int start = matcher.start();
int end = matcher.end();
stringBuilder.replace(start + shift, end + shift, replacement);
shift = shift + replacement.length() - end + start;
}
return stringBuilder.toString();
}
private String toString(Object bean, String property) {
StringBuilder stringBuilder = new StringBuilder();
try {
toString(stringBuilder, PropertyUtils.getProperty(bean, property));
} catch (IllegalAccessException e) {
addExceptionOnToStringEvaluation(stringBuilder, e.getCause().toString());
} catch (InvocationTargetException e) {
addExceptionOnToStringEvaluation(stringBuilder, e.getCause().toString());
} catch (NoSuchMethodException e) {
addExceptionOnToStringEvaluation(stringBuilder, e.getCause().toString());
} catch(Exception e){
addExceptionOnToStringEvaluation(stringBuilder, "#Warning!!! Template caused: " + e + " #");
}
return stringBuilder.toString();
}
private void addExceptionOnToStringEvaluation(StringBuilder stringBuilder, String errorMessage) {
if(errorEvaluatingToStringSymbol==null){
stringBuilder.append(errorMessage);
}else{
stringBuilder.append(errorEvaluatingToStringSymbol);
}
}
public static class EnclosingBean {
private Object object;
public EnclosingBean(Object object) {
this.object = object;
}
public EnclosingBean() {
}
public Object getArgs() {
return object;
}
public Object getResult() {
return object;
}
public Object getException() {
return object;
}
}
}
