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
023import static java.util.Objects.requireNonNull;
024
025/**
026 * {@code HashFormat} that outputs <em>only</em> the hash's digest bytes in Base64 format.  It does not print out
027 * anything else (salt, iterations, etc.).  This implementation is mostly provided as a convenience for
028 * command-line hashing.
029 *
030 * @since 1.2
031 * @deprecated will throw exceptions in 2.1.0, to be removed in 2.2.0
032 */
033@Deprecated
034public class Base64Format implements HashFormat {
035
036    /**
037     * Returns {@code hash.toBase64()}.
038     *
039     * @param hash the hash instance to format into a String.
040     * @return {@code hash.toBase64()}.
041     * @throws NullPointerException if hash is {@code null}.
042     */
043    @Override
044    public String format(final Hash hash) {
045        return requireNonNull(hash).toBase64();
046    }
047}