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