org.spongepowered.tools.obfuscation.service.IObfuscationService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sponge-mixin Show documentation

Fabric Mixin is a trait/mixin and bytecode weaving framework for Java using ASM.

The newest version!

/*
 * This file is part of Mixin, licensed under the MIT License (MIT).
 *
 * Copyright (c) SpongePowered 
 * Copyright (c) contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.spongepowered.tools.obfuscation.service;

import java.util.Collection;
import java.util.Set;

import org.spongepowered.tools.obfuscation.interfaces.IMixinAnnotationProcessor;

/**
 * Service interface for obfuscation services
 */
public interface IObfuscationService {
    
    /**
     * Get all options supported by this service
     * 
     * @return supported options as a Set
     */
    public abstract Set getSupportedOptions();

    /**
     * This method should return a collection of available obfuscation types
     * supported by this service
     *  
     * @param ap Annotation Processor instance
     * @return available obfuscation types or null
     */
    public abstract Collection getObfuscationTypes(IMixinAnnotationProcessor ap);
    
}