libcore/luni/src/main/java/javax/crypto/SecretKey.java

   1 /*
   2  *  Licensed to the Apache Software Foundation (ASF) under one or more
   3  *  contributor license agreements.  See the NOTICE file distributed with
   4  *  this work for additional information regarding copyright ownership.
   5  *  The ASF licenses this file to You under the Apache License, Version 2.0
   6  *  (the "License"); you may not use this file except in compliance with
   7  *  the License.  You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  */
  17
  18 package javax.crypto;
  19
  20 import java.security.Key;
  21
  22 /**
  23  * A cryptographic secret (symmetric) key.
  24  * <p>
  25  * This interface is a <i>marker interface</i> to group secret keys and to
  26  * provide type safety for.
  27  * <p>
  28  * Implementations of this interface have to overwrite the
  29  * {@link Object#equals(Object) equals} and {@link Object#hashCode() hashCode}
  30  * from {@link java.lang.Object} so comparison is done using the actual key data
  31  * and not the object reference.
  32  */
  33 public interface SecretKey extends Key {
  34
  35     /**
  36      * The serialization version identifier.
  37      *
  38      * @serial
  39      */
  40     public static final long serialVersionUID = -4795878709595146952L;
  41 }