com.google.auto.factory.processor.FactoryMethodDescriptor.java Source code

Introduction

Here is the source code for com.google.auto.factory.processor.FactoryMethodDescriptor.java

Source

/*
 * Copyright (C) 2013 Google, 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.google.auto.factory.processor;

import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;

import java.util.Set;

import com.google.common.base.Objects;
import com.google.common.base.Optional;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.common.collect.Sets;

/**
 * A value object representing a factory method to be generated.
 *
 * @author Gregory Kick
 */
final class FactoryMethodDescriptor {
    private final AutoFactoryDeclaration declaration;
    private final String factoryName;
    private final String name;
    private final String returnType;
    private final boolean publicMethod;
    private final boolean override;
    private final ImmutableSet<Parameter> passedParameters;
    private final ImmutableSet<Parameter> providedParameters;
    private final ImmutableSet<Parameter> creationParameters;

    private FactoryMethodDescriptor(Builder builder) {
        this.declaration = builder.declaration;
        this.factoryName = builder.factoryName.get();
        this.name = builder.name.get();
        this.returnType = builder.returnType.get();
        this.publicMethod = builder.publicMethod;
        this.override = builder.override;
        this.passedParameters = ImmutableSet.copyOf(builder.passedParameters);
        this.providedParameters = ImmutableSet.copyOf(builder.providedParameters);
        this.creationParameters = ImmutableSet.copyOf(builder.creationParameters);
        checkState(creationParameters.equals(Sets.union(passedParameters, providedParameters)));
    }

    AutoFactoryDeclaration declaration() {
        return declaration;
    }

    String factoryName() {
        return factoryName;
    }

    String name() {
        return name;
    }

    String returnType() {
        return returnType;
    }

    public boolean publicMethod() {
        return publicMethod;
    }

    public boolean override() {
        return override;
    }

    ImmutableSet<Parameter> passedParameters() {
        return passedParameters;
    }

    ImmutableSet<Parameter> providedParameters() {
        return providedParameters;
    }

    ImmutableSet<Parameter> creationParameters() {
        return creationParameters;
    }

    @Override
    public String toString() {
        return Objects.toStringHelper(this).add("factoryName", factoryName).add("name", name)
                .add("returnType", returnType).add("passed", passedParameters).add("provided", providedParameters)
                .toString();
    }

    static final class Builder {
        private final AutoFactoryDeclaration declaration;
        private Optional<String> factoryName = Optional.absent();
        private Optional<String> name = Optional.absent();
        private Optional<String> returnType = Optional.absent();
        private boolean publicMethod = false;
        private boolean override = false;
        private final Set<Parameter> passedParameters = Sets.newLinkedHashSet();
        private final Set<Parameter> providedParameters = Sets.newLinkedHashSet();
        private final Set<Parameter> creationParameters = Sets.newLinkedHashSet();

        Builder(AutoFactoryDeclaration declaration) {
            this.declaration = checkNotNull(declaration);
        }

        Builder factoryName(String factoryName) {
            this.factoryName = Optional.of(factoryName);
            return this;
        }

        Builder name(String name) {
            this.name = Optional.of(name);
            return this;
        }

        Builder returnType(String returnType) {
            this.returnType = Optional.of(returnType);
            return this;
        }

        Builder publicMethod() {
            return publicMethod(true);
        }

        Builder publicMethod(boolean publicMethod) {
            this.publicMethod = publicMethod;
            return this;
        }

        Builder override() {
            this.override = true;
            return this;
        }

        Builder passedParameters(Iterable<Parameter> passedParameters) {
            Iterables.addAll(this.passedParameters, passedParameters);
            return this;
        }

        Builder providedParameters(Iterable<Parameter> providedParameters) {
            Iterables.addAll(this.providedParameters, providedParameters);
            return this;
        }

        Builder creationParameters(Iterable<Parameter> creationParameters) {
            Iterables.addAll(this.creationParameters, creationParameters);
            return this;
        }

        FactoryMethodDescriptor build() {
            return new FactoryMethodDescriptor(this);
        }
    }
}