001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.shiro.crypto.hash.format;
020
021import org.apache.shiro.crypto.hash.Hash;
022
023/**
024 * {@code HashFormat} that outputs <em>only</em> The hash's digest bytes in hex format.  It does not print out
025 * anything else (salt, iterations, etc).  This implementation is mostly provided as a convenience for
026 * command-line hashing.
027 *
028 * @since 1.2
029 */
030public class HexFormat implements HashFormat {
031
032    /**
033     * Returns {@code hash != null ? hash.toHex() : null}.
034     *
035     * @param hash the hash instance to format into a String.
036     * @return {@code hash != null ? hash.toHex() : null}.
037     */
038    public String format(Hash hash) {
039        return hash != null ? hash.toHex() : null;
040    }
041}