com.facebook.buck.rules.args.Arg.java Source code

Introduction

Here is the source code for com.facebook.buck.rules.args.Arg.java

Source

/*
 * Copyright 2015-present Facebook, 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.facebook.buck.rules.args;

import com.facebook.buck.rules.BuildRule;
import com.facebook.buck.rules.RuleKeyAppendable;
import com.facebook.buck.rules.SourcePath;
import com.facebook.buck.rules.SourcePathRuleFinder;
import com.google.common.base.Joiner;
import com.google.common.collect.ImmutableCollection;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;

import java.util.Map;

/**
 * An abstraction for modeling the arguments that contribute to a command run by a
 * {@link BuildRule}.
 */
public abstract class Arg implements RuleKeyAppendable {

    /**
     * @return any {@link BuildRule}s that need to be built before this argument can be used.
     */
    public abstract ImmutableCollection<BuildRule> getDeps(SourcePathRuleFinder ruleFinder);

    /**
     * @return any {@link BuildRule}s that need to be built before this argument can be used.
     */
    public abstract ImmutableCollection<SourcePath> getInputs();

    /**
     * Append the contents of the Arg to the supplied builder. This call may inject any number
     * of elements (including zero) into the builder. This is only ever safe to call when the
     * rule is running, as it may do things like resolving source paths.
     */
    public abstract void appendToCommandLine(ImmutableCollection.Builder<String> builder);

    /**
     * @return a {@link String} representation suitable to use for debugging.
     */
    @Override
    public abstract String toString();

    @Override
    public abstract boolean equals(Object other);

    @Override
    public abstract int hashCode();

    public static ImmutableList<String> stringifyList(Arg input) {
        ImmutableList.Builder<String> builder = ImmutableList.builder();
        input.appendToCommandLine(builder);
        return builder.build();
    }

    public static ImmutableList<String> stringify(ImmutableCollection<Arg> args) {
        ImmutableList.Builder<String> builder = ImmutableList.builder();
        for (Arg arg : args) {
            arg.appendToCommandLine(builder);
        }
        return builder.build();
    }

    public static <K> ImmutableMap<K, String> stringify(ImmutableMap<K, Arg> argMap) {
        ImmutableMap.Builder<K, String> stringMap = ImmutableMap.builder();
        for (Map.Entry<K, Arg> ent : argMap.entrySet()) {
            ImmutableList.Builder<String> builder = ImmutableList.builder();
            ent.getValue().appendToCommandLine(builder);
            stringMap.put(ent.getKey(), Joiner.on(" ").join(builder.build()));
        }
        return stringMap.build();
    }

}