001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2017 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.checks;
021
022import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
023import com.puppycrawl.tools.checkstyle.api.DetailAST;
024import com.puppycrawl.tools.checkstyle.api.FileContents;
025import com.puppycrawl.tools.checkstyle.utils.CommonUtils;
026
027/**
028 * Holds the current file contents for global access when configured
029 * as a TreeWalker sub-module. For example,
030 * a filter can access the current file contents through this module.
031 * @author Mike McMahon
032 * @author Rick Giles
033 */
034public class FileContentsHolder extends AbstractCheck {
035    /** The current file contents. */
036    private static FileContents currentFileContents;
037
038    /**
039     * @return the current file contents.
040     */
041    public static FileContents getCurrentFileContents() {
042        return currentFileContents;
043    }
044
045    /**
046     * @return the current file contents.
047     * @deprecated use getCurrentFileContents() instead.
048     */
049    @Deprecated
050    public static FileContents getContents() {
051        return getCurrentFileContents();
052    }
053
054    @Override
055    public int[] getDefaultTokens() {
056        return CommonUtils.EMPTY_INT_ARRAY;
057    }
058
059    @Override
060    public int[] getAcceptableTokens() {
061        return CommonUtils.EMPTY_INT_ARRAY;
062    }
063
064    @Override
065    public int[] getRequiredTokens() {
066        return getAcceptableTokens();
067    }
068
069    @Override
070    public void beginTree(DetailAST rootAST) {
071        currentFileContents = getFileContents();
072    }
073}