org.glowroot.config.PluginDescriptorBase Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of glowroot-test-harness Show documentation
Glowroot Test Harness
The newest version!
/*
 * Copyright 2012-2015 the original author or authors.
 *
 * 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.glowroot.config;

import java.util.Locale;

import javax.annotation.Nullable;

import org.glowroot.shaded.fasterxml.jackson.annotation.JsonProperty;
import org.glowroot.shaded.google.common.collect.ImmutableList;
import org.glowroot.shaded.google.common.collect.Ordering;
import org.immutables.value.Value;

import static org.glowroot.shaded.google.common.base.Preconditions.checkNotNull;

@Value.Immutable
public abstract class PluginDescriptorBase {

    static final Ordering specialOrderingByName =
            new Ordering() {
                @Override
                public int compare(@Nullable PluginDescriptor left,
                        @Nullable PluginDescriptor right) {
                    checkNotNull(left);
                    checkNotNull(right);
                    // conventionally plugin names ends with " Plugin", so strip this off when
                    // comparing names so that, e.g., "Abc Plugin" will come before
                    // "Abc Extra Plugin"
                    String leftName = stripEndingIgnoreCase(left.name(), " Plugin");
                    String rightName = stripEndingIgnoreCase(right.name(), " Plugin");
                    return leftName.compareToIgnoreCase(rightName);
                }
            };

    static final Ordering orderingById = new Ordering() {
        @Override
        public int compare(@Nullable PluginDescriptor left, @Nullable PluginDescriptor right) {
            checkNotNull(left);
            checkNotNull(right);
            return left.id().compareToIgnoreCase(right.id());
        }
    };

    public abstract String name();
    public abstract String id();
    public abstract ImmutableList transactionTypes();
    public abstract ImmutableList transactionCustomAttributes();
    public abstract ImmutableList properties();
    @JsonProperty("instrumentation")
    public abstract ImmutableList instrumentationConfigs();
    public abstract ImmutableList aspects();

    private static String stripEndingIgnoreCase(String original, String ending) {
        if (original.toUpperCase(Locale.ENGLISH).endsWith(ending.toUpperCase(Locale.ENGLISH))) {
            return original.substring(0, original.length() - ending.length());
        } else {
            return original;
        }
    }
}