status-printer/src/main/java/org/apache/felix/status/impl/StatusPrinterDescription.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.felix.status.impl;

import java.util.Arrays;

import org.apache.felix.status.PrinterMode;
import org.apache.felix.status.StatusPrinter;
import org.osgi.framework.ServiceReference;

/**
 * Helper class for a configuration printer.
 */
public class StatusPrinterDescription implements Comparable<StatusPrinterDescription> {

    private final ServiceReference reference;

    private final PrinterMode[] modes;

    private final String name;

    private final String title;

    private final String sortKey;

    private final String category;

    public StatusPrinterDescription(final ServiceReference ref) {
        this.reference = ref;

        // check modes
        final Object modesCfg = ref.getProperty(StatusPrinter.CONFIG_PRINTER_MODES);
        if ( modesCfg instanceof String ) {
            this.modes = new PrinterMode[] { PrinterMode.valueOf((String)modesCfg)};
        } else if ( modesCfg instanceof String[] ) {
            final String[] modesCfgArray = (String[])modesCfg;
            this.modes = new PrinterMode[modesCfgArray.length];
            for(int i=0; i<modesCfgArray.length;i++) {
                this.modes[i] = PrinterMode.valueOf(modesCfgArray[i]);
            }
        } else {
            this.modes = null;
        }

        // check name
        if ( ref.getProperty(StatusPrinter.CONFIG_NAME) != null ) {
            this.name = ref.getProperty(StatusPrinter.CONFIG_NAME).toString();
        } else {
            this.name = null;
        }

        // check title
        if ( ref.getProperty(StatusPrinter.CONFIG_TITLE) != null ) {
            this.title = ref.getProperty(StatusPrinter.CONFIG_TITLE).toString();
            if ( this.title.startsWith("%") ) {
                this.sortKey = this.title.substring(1);
            } else {
                this.sortKey = this.title;
            }
        } else {
            this.title = null;
            this.sortKey = null;
        }

        // check category
        if ( ref.getProperty(StatusPrinter.CONFIG_CATEGORY) != null ) {
            this.category = ref.getProperty(StatusPrinter.CONFIG_CATEGORY).toString();
        } else {
            this.category = null;
        }
    }

    public String getTitle() {
        return this.title;
    }

    public String getSortKey() {
        return this.sortKey;
    }

    public String getName() {
        return this.name;
    }

    public String getCategory() {
        return this.category;
    }

    public PrinterMode[] getModes() {
        return this.modes;
    }

    public ServiceReference getServiceReference() {
        return this.reference;
    }

    /**
     * @see java.lang.Comparable#compareTo(java.lang.Object)
     */
    public int compareTo(final StatusPrinterDescription spa) {
        return this.reference.compareTo(spa.reference);
    }

    @Override
    public boolean equals(final Object obj) {
        return this.reference.equals(obj);
    }

    @Override
    public int hashCode() {
        return this.reference.hashCode();
    }

    @Override
    public String toString() {
        return "StatusPrinterDescription [title=" + title + ", name=" + name
                + ", modes=" + Arrays.toString(modes) + ", sortKey=" + sortKey
                + ", category=" + category + "]";
    }
}