com.reprezen.swagedit.assist.Proposal.java Source code

Introduction

Here is the source code for com.reprezen.swagedit.assist.Proposal.java

Source

/*******************************************************************************
 * Copyright (c) 2016 ModelSolv, Inc. and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    ModelSolv, Inc. - initial API and implementation and/or initial documentation
 *******************************************************************************/
package com.reprezen.swagedit.assist;

import java.util.Objects;

import org.eclipse.jface.text.contentassist.CompletionProposal;
import org.eclipse.jface.viewers.StyledString;
import org.eclipse.jface.viewers.StyledString.Styler;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.RGB;
import org.eclipse.swt.graphics.TextStyle;
import org.eclipse.swt.widgets.Display;

import com.google.common.base.Strings;

public class Proposal {

    public final String replacementString;
    public final String displayString;
    public final String type;
    public final String description;

    protected final Styler typeStyler = new StyledString.Styler() {
        @Override
        public void applyStyles(TextStyle textStyle) {
            textStyle.foreground = new Color(Display.getCurrent(), new RGB(120, 120, 120));
        }
    };

    public Proposal(String replacementString, String displayString, String description, String type) {
        this.replacementString = replacementString;
        this.displayString = displayString;
        this.type = type;
        this.description = description;
    }

    /**
     * Returns a {@link CompletionProposal}.
     * 
     * The {@link CompletionProposal} will be returned only if the prefix is null, or if the replacement string starts
     * with or contains the prefix. Otherwise this method returns null.
     * 
     * @param prefix
     * @param offset
     * @return proposal
     */
    public StyledCompletionProposal asStyledCompletionProposal(String prefix, int offset) {
        final StyledString styledString = new StyledString(displayString);
        if (type != null) {
            styledString.append(": ", typeStyler).append(type, typeStyler);
        }

        StyledCompletionProposal proposal = null;
        if (Strings.emptyToNull(prefix) == null) {
            proposal = new StyledCompletionProposal(replacementString, styledString, null, description, offset);
        } else if (replacementString.contains(prefix) || replacementString.startsWith(prefix)) {
            proposal = new StyledCompletionProposal(replacementString, styledString, prefix, description, offset);
        }

        return proposal;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((displayString == null) ? 0 : displayString.hashCode());

        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (!(obj instanceof Proposal)) {
            return false;
        }

        Proposal other = (Proposal) obj;

        return Objects.equals(other.displayString, displayString);
    }

}