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.factory;
18
19 import io.github.tonywasher.joceanus.gordianknot.api.base.GordianException;
20 import io.github.tonywasher.joceanus.gordianknot.api.base.GordianIdSpec;
21
22 /**
23 * GordianKnot Knuth Obfuscator API.
24 */
25 public interface GordianKnuthObfuscater {
26 /**
27 * Obtain external Id from Type.
28 *
29 * @param pType the type
30 * @param pAdjustment the adjustment
31 * @return the externalId
32 * @throws GordianException on error
33 */
34 int deriveExternalIdFromType(GordianIdSpec pType,
35 int pAdjustment) throws GordianException;
36
37 /**
38 * Obtain external Id from Type.
39 *
40 * @param pType the type
41 * @return the externalId
42 * @throws GordianException on error
43 */
44 int deriveExternalIdFromType(GordianIdSpec pType) throws GordianException;
45
46 /**
47 * Obtain IdSpec from external Id.
48 *
49 * @param pId the externalId
50 * @param pAdjustment the adjustment
51 * @return the derived Type
52 * @throws GordianException on error
53 */
54 GordianIdSpec deriveTypeFromExternalId(int pId,
55 int pAdjustment) throws GordianException;
56
57 /**
58 * Obtain IdSpec from external Id.
59 *
60 * @param pId the externalId
61 * @return the derived Type
62 * @throws GordianException on error
63 */
64 GordianIdSpec deriveTypeFromExternalId(int pId) throws GordianException;
65 }