de.micromata.genome.logging.LogAttribute.java Source code

Introduction

Here is the source code for de.micromata.genome.logging.LogAttribute.java

Source

//
// Copyright (C) 2010-2016 Micromata GmbH
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//  http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

package de.micromata.genome.logging;

import java.io.Serializable;
import java.util.Map;

import java.util.Objects;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.Validate;
import org.apache.commons.text.StringEscapeUtils;

/**
 * Ein Log-Attribute. Der Type wird durch LogAttributeType festgelegt.
 * 
 * @author roger@micromata.de
 * 
 */
public class LogAttribute implements Serializable {

    /**
     * The Constant serialVersionUID.
     */
    private static final long serialVersionUID = 4447381062765214393L;

    /**
     * The type.
     */
    private LogAttributeType type;

    /**
     * The value.
     */
    private String value;

    /**
     * Instantiates a new log attribute.
     */
    protected LogAttribute() {
    }

    /**
     * Instantiates a new log attribute.
     *
     * @param type the type
     * @param value the value
     */
    public LogAttribute(LogAttributeType type, String value) {
        Validate.notNull(type);
        this.type = type;
        this.value = value;
    }

    public final boolean isSearchKey() {
        return type.isSearchKey();
    }

    /**
     * Shorten.
     *
     * @param val the val
     * @param size the size
     * @return the string
     */
    public static String shorten(String val, int size) {
        if (val == null) {
            return StringUtils.EMPTY;
        }
        if (val.length() > size) {
            return val.substring(0, size);
        } else {
            return val;
        }
    }

    public LogAttributeType getType() {
        return type;
    }

    @Override
    public int hashCode() {
        return Objects.hashCode(type);// don't because has to be equals * 17 + Objects.hashCode(value);
    }

    /**
     * Prueft nur ob type identisch ist.
     */
    @Override
    public boolean equals(Object other) {
        if ((other instanceof LogAttribute) == false) {
            return false;
        }
        LogAttribute lo = (LogAttribute) other;
        return type == lo.getType();
    }

    public final void setType(LogAttributeType type) {
        this.type = type;
    }

    public final String getTypeName() {
        return type.name();
    }

    public String getValue() {
        return value;
    }

    /**
     * Used to overwrite in dynamic values, in cases of logging more if level is error.
     * 
     * If orginal value is not empty, pass always value.
     *
     * @param lwe log to write.
     * @return the value to write
     */
    public String getValueToWrite(LogWriteEntry lwe) {
        return getValue();
    }

    public String getEscapedValue() {
        return StringEscapeUtils.escapeXml10(value);
    }

    public void setValue(String value) {
        this.value = value;
    }

    @Override
    public String toString() {
        return type.name() + "|" + value;
    }

    /**
     * helper to render a map to a string.
     *
     * @param reqMap the req map
     * @return the request dump
     */
    public static String getRequestDump(Map<String, String> reqMap) {
        StringBuilder sb = new StringBuilder();
        for (Map.Entry<String, String> e : reqMap.entrySet()) {
            sb.append('|').append(e.getKey()).append('=').append(e.getValue()).append('\n');
        }
        return sb.toString();
    }

}