/*
 * FindBugs - Find Bugs in Java programs
 * Copyright (C) 2003-2007 University of Maryland
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package edu.umd.cs.findbugs.detect;

import edu.umd.cs.findbugs.BugInstance;
import edu.umd.cs.findbugs.BugReporter;

/**
 * Methods with "Optional" return type should never return null.
 *
 * @author Andrey Loskutov
 */
public class OptionalReturnNull extends TypeReturnNull {

    public OptionalReturnNull(BugReporter bugReporter) {
        super(bugReporter);
    }

    @Override
    protected boolean matchesReturnSignature(String returnSignature) {
        return "Ljava/util/Optional;".equals(returnSignature)
                || "Lcom/google/common/base/Optional;".equals(returnSignature);
    }

    @Override
    protected void accumulateBug() {
        bugAccumulator.accumulateBug(new BugInstance(this, "NP_OPTIONAL_RETURN_NULL",
                HIGH_PRIORITY).addClassAndMethod(this), this);
    }


}
