org.codenarc.source.SourceString.groovy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of CodeNarc Show documentation
Show all versions of CodeNarc Show documentation
The CodeNarc project provides a static analysis tool for Groovy code.
/*
* Copyright 2008 the original author or authors.
*
* 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.
*/
package org.codenarc.source
import org.codenarc.analyzer.SuppressionAnalyzer
/**
* SourceCode implementation that uses source from a pre-defined String.
* Note that the path is normalized: file separator chars are normalized to standard '/'.
*
* @author Chris Mair
*/
class SourceString extends AbstractSourceCode {
String path
String name
private final String source
/**
* Construct a new instance for the file at the specified path
* @param source - the source code; may be empty
* @param path - the path for the source code; may be null; defaults to null
* @param name - the name for the source code; may be null; defaults to null
*/
SourceString(String source, String path=null, String name=null) {
assert source != null
this.source = source
setPath(path)
this.name = name
this.suppressionAnalyzer = new SuppressionAnalyzer(this)
}
/**
* @return the full text of the source code
*/
@Override
String getText() {
source
}
void setPath(String path) {
this.path = path ? normalizePath(path) : path
}
@Override
String toString() {
"SourceString[$source]"
}
}