pgpainless/pgpainless-core/src/main/java/org/pgpainless/key/generation/KeyRingBuilderInterface.java

/*
 * Copyright 2018-2020 Paul Schaub.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.pgpainless.key.generation;

import java.security.InvalidAlgorithmParameterException;
import java.security.NoSuchAlgorithmException;
import javax.annotation.Nonnull;

import org.bouncycastle.openpgp.PGPException;
import org.bouncycastle.openpgp.PGPSecretKeyRing;
import org.pgpainless.key.util.UserId;
import org.pgpainless.util.Passphrase;

public interface KeyRingBuilderInterface {

    KeyRingBuilderInterface withSubKey(@Nonnull KeySpec keySpec);

    /**
     * Define the primary key spec.
     *
     * @deprecated use {@link #withPrimaryKey(KeySpec)} instead.
     * @param keySpec key spec
     * @return builder step
     */
    @Deprecated
    default WithPrimaryUserId withMasterKey(@Nonnull KeySpec keySpec) {
        return withPrimaryKey(keySpec);
    }

    WithPrimaryUserId withPrimaryKey(@Nonnull KeySpec keySpec);

    interface WithPrimaryUserId {

        default WithAdditionalUserIdOrPassphrase withPrimaryUserId(@Nonnull UserId userId) {
            return withPrimaryUserId(userId.toString());
        }

        WithAdditionalUserIdOrPassphrase withPrimaryUserId(@Nonnull String userId);

        WithAdditionalUserIdOrPassphrase withPrimaryUserId(@Nonnull byte[] userId);

    }

    interface WithAdditionalUserIdOrPassphrase {

        default WithAdditionalUserIdOrPassphrase withAdditionalUserId(@Nonnull UserId userId) {
            return withAdditionalUserId(userId.toString());
        }

        WithAdditionalUserIdOrPassphrase withAdditionalUserId(@Nonnull String userId);

        WithAdditionalUserIdOrPassphrase withAdditionalUserId(@Nonnull byte[] userId);

        Build withPassphrase(@Nonnull Passphrase passphrase);

        Build withoutPassphrase();
    }

    interface Build {

        PGPSecretKeyRing build() throws NoSuchAlgorithmException, PGPException,
                InvalidAlgorithmParameterException;
    }
}