com.pi4j.common.impl.DescriptorImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pi4j-core Show documentation
Pi4J Java API & Runtime Library
The newest version!
package com.pi4j.common.impl;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  DescriptorImpl.java
 *
 * This file is part of the Pi4J project. More information about
 * this project can be found here:  https://pi4j.com/
 * **********************************************************************
 * 
 * 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.
 * #L%
 */

import com.pi4j.common.Descriptor;

import java.io.PrintStream;
import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.stream.Collectors;

/**
 * DescriptorImpl class.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public class DescriptorImpl implements Descriptor {

    private Set children = Collections.synchronizedSet(new LinkedHashSet());
    private Descriptor parent;

    private String id;
    private String name;
    private String description;
    private String category;
    private Integer quantity;
    private Class type;
    private Object value;

    /**
     * Constructor for DescriptorImpl.
     */
    public DescriptorImpl(){
        this.parent = null;
    }

    /** {@inheritDoc} */
    @Override
    public Descriptor id(String id) {
        this.id = id;
        return this;
    }

    /** {@inheritDoc} */
    @Override
    public Descriptor name(String name) {
        this.name = name;
        return this;
    }

    /** {@inheritDoc} */
    @Override
    public Descriptor description(String description) {
        this.description = description;
        return this;
    }

    /** {@inheritDoc} */
    @Override
    public Descriptor category(String category) {
        this.category = category;
        return this;
    }

    /** {@inheritDoc} */
    @Override
    public Descriptor quantity(Integer quantity) {
        this.quantity = quantity;
        return this;
    }

    /** {@inheritDoc} */
    @Override
    public Descriptor value(Object value) {
        this.value = value;
        return this;
    }

    /** {@inheritDoc} */
    @Override
    public Descriptor type(Class type) {
        this.type = type;
        return this;
    }

    /** {@inheritDoc} */
    @Override
    public Descriptor parent(Descriptor parent) {
        this.parent = parent;
        return this;
    }

    /** {@inheritDoc} */
    @Override
    public String id() {
        return this.id;
    }

    /** {@inheritDoc} */
    @Override
    public String name() {
        return this.name;
    }

    /** {@inheritDoc} */
    @Override
    public String description() {
        return this.description;
    }

    /** {@inheritDoc} */
    @Override
    public String category() {
        return this.category;
    }

    /** {@inheritDoc} */
    @Override
    public Integer quantity() {
        return this.quantity;
    }

    /** {@inheritDoc} */
    @Override
    public Object value() {
        return this.value;
    }

    /** {@inheritDoc} */
    @Override
    public Class type() {
        return this.type;
    }

    /** {@inheritDoc} */
    @Override
    public Descriptor parent() {
        return this.parent;
    }

    /** {@inheritDoc} */
    @Override
    public Descriptor add(Descriptor descriptor) {
        if(descriptor != null) {
            this.children.add(descriptor.parent(this));
        }
        return this;
    }

    /**
     * size.
     *
     * @return a int.
     */
    public int size(){
        return children.size();
    }

    /**
     * isEmpty.
     *
     * @return a boolean.
     */
    public boolean isEmpty(){
        return children.isEmpty();
    }

    /**
     * isNotEmpty.
     *
     * @return a boolean.
     */
    public boolean isNotEmpty(){
        return !children.isEmpty();
    }

    /** {@inheritDoc} */
    public void print(PrintStream stream){
        print(stream, "", new ArrayList<>());
    }
    private void print(PrintStream stream, String prefix, ArrayList parents){

        // print this descriptors description text (preceded by prefix)
        stream.print(prefix);

        // include category
        if(this.category != null){
            stream.print(this.category);
            stream.print(": ");
        }

        // include quantity
        if(this.quantity != null){
            stream.print("[");
            stream.print(this.quantity.toString());
            stream.print("] ");
        }

        // include name
        if(this.name != null) {
            stream.print("\"");
            stream.print(this.name);
            stream.print("\" ");
        }

        // include value
        if(this.value != null) {
            stream.print("= ");
            stream.print(this.value.toString());
            stream.print(" ");
        }

        // include ID
        if(this.id != null){
            stream.print("{");
            stream.print(this.id);
            stream.print("} ");
        }

        // include class type
        if(this.type != null){
            stream.print("<");
            stream.print(this.type.getName());
            stream.print("> ");
        }

        // include description
        if(this.description != null){
            stream.print("{");
            stream.print(this.description);
            stream.print("} ");
        }

        stream.println();

        var children = this.children.stream().collect(Collectors.toSet());

        // loop over this descriptor's children
        var iterator = children.iterator();
        while (iterator.hasNext()) {

            // get the child descriptor instance
            var descriptor = iterator.next();
            String p = "";

            // iterate over the provided parents collection of boolean states
            // which represent if the parent has more children to describe
            for(Boolean parentHasNext : parents){
                p += (parentHasNext) ? "│ " : "  ";
            };

            // append to the prefix the graphical tree structure for this branch
            // depending on if there are more children remaining to describe
            p += (iterator.hasNext()) ? "├─" : "└─";

            // add a parent level to the parent collection
            parents.add(iterator.hasNext());

            // describe this child branch/node
            if(descriptor instanceof Descriptor)
                ((DescriptorImpl)descriptor).print(stream, p, parents);
            //if(descriptor instanceof )

            // remove the parent level from the parent collection
            parents.remove(parents.size()-1);
        }
    }
}