com.stormpath.sdk.phone.CreatePhoneRequestBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stormpath-sdk-api Show documentation

The Stormpath Java SDK API .jar provides a Java API that your code can use to make calls to the Stormpath API. This .jar is the only compile-time dependency within the Stormpath SDK project that your code should depend on. Implementations of this API (implementation .jars) should be runtime dependencies only.

The newest version!

/*
 * Copyright 2016 Stormpath, Inc.
 *
 * 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 com.stormpath.sdk.phone;

/**
 * A Builder to construct {@link CreatePhoneRequest}s.
 *
 * @see com.stormpath.sdk.account.Account#createPhone(CreatePhoneRequest)
 * @since 1.1.0
 */
public interface CreatePhoneRequestBuilder {

    /**
     * Ensures that after a Phone is created, the creation response is retrieved with the specified phone's
     * options. This enhances performance by leveraging a single request to retrieve multiple related
     * resources you know you will use.
     *
     * @return the builder instance for method chaining.
     * @throws IllegalArgumentException if {@code options} is null.
     */
    CreatePhoneRequestBuilder withResponseOptions(PhoneOptions options) throws IllegalArgumentException;

    /**
     * Creates a new {@code CreatePhoneRequest} instance based on the current builder state.
     *
     * @return a new {@code CreatePhoneRequest} instance based on the current builder state.
     */
    CreatePhoneRequest build();
}