org.owasp.fileio.util.NullSafe Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-file-io Show documentation

The OWASP Java File I/O Security Project provides an easy to use library for validating and sanitizing filenames, directory paths, and uploaded files.

The newest version!

/**
 * This file is part of the Open Web Application Security Project (OWASP) Java File IO Security project. For details, please see
 * https://www.owasp.org/index.php/OWASP_Java_File_I_O_Security_Project.
 *
 * Copyright (c) 2014 - The OWASP Foundation
 *
 * This API is published by OWASP under the Apache 2.0 license. You should read and accept the LICENSE before you use, modify, and/or redistribute this software.
 *
 * @author August Detlefsen CodeMagi - Java File IO Security Project lead
 * @created 2014
 */
package org.owasp.fileio.util;

public class NullSafe {

    /**
     * Class should not be instantiated.
     */
    private NullSafe() {
    }

    /**
     * {@link Object#equals(Object)} that safely handles nulls.
     *
     * @param a First object
     * @param b Second object
     * @return true if a == b or a.equals(b). false otherwise.
     */
    public static boolean equals(Object a, Object b) {
	if (a == b) // short cut same object
	{
	    return true;
	}
	if (a == null) {
	    return (b == null);
	}
	if (b == null) {
	    return false;
	}
	return a.equals(b);
    }

    /**
     * {@link Object#hashCode()} of an object.
     *
     * @param o Object to get a hashCode for.
     * @return 0 if o is null. Otherwise o.hashCode().
     */
    public static int hashCode(Object o) {
	if (o == null) {
	    return 0;
	}
	return o.hashCode();
    }

    /**
     * {@link Object#toString()} of an object.
     *
     * @param o Object to get a String for.
     * @return "(null)" o is null. Otherwise o.toString().
     */
    public static String toString(Object o) {
	if (o == null) {
	    return "(null)";
	}
	return o.toString();
    }
}