1 /*
2 * GordianKnot: Security Suite
3 * Copyright 2026. Tony Washer
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy
7 * 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, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18 package io.github.tonywasher.joceanus.gordianknot.api.digest.spec;
19
20 import io.github.tonywasher.joceanus.gordianknot.api.base.GordianIdSpec;
21 import io.github.tonywasher.joceanus.gordianknot.api.base.GordianLength;
22 import io.github.tonywasher.joceanus.gordianknot.api.digest.spec.GordianDigestSubSpec.GordianDigestState;
23
24 /**
25 * DataDigestSpec definition.
26 */
27 public interface GordianDigestSpec
28 extends GordianIdSpec {
29 /**
30 * Obtain Digest Type.
31 *
32 * @return the DigestType
33 */
34 GordianDigestType getDigestType();
35
36 /**
37 * Obtain DigestSubSpec.
38 *
39 * @return the SubSpec
40 */
41 GordianDigestSubSpec getSubSpec();
42
43 /**
44 * Obtain DigestState.
45 *
46 * @return the State
47 */
48 GordianDigestState getDigestState();
49
50 /**
51 * Obtain Digest Length.
52 *
53 * @return the Length
54 */
55 GordianLength getDigestLength();
56
57 /**
58 * Is the digestSpec a Xof mode?
59 *
60 * @return true/false.
61 */
62 boolean isXofMode();
63
64 /**
65 * Is the digestSpec valid?
66 *
67 * @return true/false.
68 */
69 boolean isValid();
70 }