com.google.crypto.tink.KeyTemplates Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tink-android Show documentation

Tink is a small cryptographic library that provides a safe, simple, agile and fast way to accomplish some common cryptographic tasks.

The newest version!

// Copyright 2021 Google LLC
//
// 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 com.google.crypto.tink;

import com.google.crypto.tink.internal.MutableParametersRegistry;
import java.security.GeneralSecurityException;

/**
 * This class consists exclusively of static methods that load {@link KeyTemplate} objects.
 *
 * @since 1.6.0
 */
public final class KeyTemplates {

  /**
   * Returns a key template that was registered with the {@link Registry} as {@code name}.
   *
   * @throws GeneralSecurityException if cannot find key template with name {@code name} in the
   *     Registry
   * @since 1.6.0
   */
  public static KeyTemplate get(String name) throws GeneralSecurityException {
    Parameters result = MutableParametersRegistry.globalInstance().get(name);
    return KeyTemplate.createFrom(result);
  }

  private KeyTemplates() {}
}