1 /*
2 * GordianKnot: Security Suite
3 * Copyright 2012-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 package io.github.tonywasher.joceanus.gordianknot.api.digest;
18
19 import io.github.tonywasher.joceanus.gordianknot.api.base.GordianException;
20
21 import java.util.List;
22 import java.util.function.Predicate;
23
24 /**
25 * Digest factory.
26 */
27 public interface GordianDigestFactory {
28 /**
29 * create GordianDigest.
30 *
31 * @param pDigestSpec the DigestSpec
32 * @return the new Digest
33 * @throws GordianException on error
34 */
35 GordianDigest createDigest(GordianDigestSpec pDigestSpec) throws GordianException;
36
37 /**
38 * Obtain predicate for supported digestSpecs.
39 *
40 * @return the predicate
41 */
42 Predicate<GordianDigestSpec> supportedDigestSpecs();
43
44 /**
45 * Obtain predicate for supported digestTypes.
46 *
47 * @return the predicate
48 */
49 Predicate<GordianDigestType> supportedDigestTypes();
50
51 /**
52 * Obtain a list of supported digestSpecs.
53 *
54 * @return the list of supported digestSpecs.
55 */
56 List<GordianDigestSpec> listAllSupportedSpecs();
57
58 /**
59 * Obtain a list of supported digestTypes.
60 *
61 * @return the list of supported digestTypes.
62 */
63 List<GordianDigestType> listAllSupportedTypes();
64
65 /**
66 * List all possible digestSpecs.
67 *
68 * @return the list
69 */
70 List<GordianDigestSpec> listAllPossibleSpecs();
71 }