de.vandermeer.skb.interfaces.antlr.Antlr_To_FileName Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of skb-interfaces Show documentation
Show all versions of skb-interfaces Show documentation
Set of interfaces used by other SKB projects.
/* Copyright 2016 Sven van der Meer
*
* 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 de.vandermeer.skb.interfaces.antlr;
import de.vandermeer.skb.interfaces.transformers.IsTransformer;
/**
* A transformer that takes an ANTLR runtime object and returns aits souce file name (of the first token).
*
* @author Sven van der Meer <[email protected]>
* @version v0.0.1 build 170404 (04-Apr-17) for Java 1.8
* @since v0.0.1
*/
public interface Antlr_To_FileName extends IsTransformer {
@Override
default String transform(Object obj){
IsTransformer.super.transform(obj);
if(obj instanceof IsAntlrRuntimeObject){
return ((IsAntlrRuntimeObject)obj).getFilename();
}
return IsAntlrRuntimeObject.create(obj).getFilename();
}
/**
* Creates a transformer that takes an ANTLR object and returns the file name where the first token was found.
* The returned transformer will throw runtime exceptions (null pointer, illegal argument) if the given object was not an ANTLR runtime object.
* The transformer returns null or filename for ANTLR classes (`RecognitionException`, `Token`, `ParserRuleContext`, `TerminalNode`).
* @return new transformer
*/
static Antlr_To_FileName create(){
return new Antlr_To_FileName() {};
}
}