org.pantsbuild.jarjar.misplaced

Class MisplacedClassProcessor

java.lang.Object

org.pantsbuild.jarjar.misplaced.MisplacedClassProcessor

All Implemented Interfaces:

JarProcessor

Direct Known Subclasses:

FatalMisplacedClassProcessor, MoveMisplacedClassProcessor, OmitMisplacedClassProcessor, SkipMisplacedClassProcessor

public abstract class MisplacedClassProcessor
extends java.lang.Object
implements JarProcessor

Processor that handles classes whose fully-qualified names do not match their jar entry location.

Constructor Summary

Constructors

Constructor and Description
MisplacedClassProcessor()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	formatMisplacedClassMessage(EntryStruct classStruct, java.lang.String className)
abstract void	handleMisplacedClass(EntryStruct classStruct, java.lang.String className) Handles a class that was found at a location that does not match its fully qualified classname.
boolean	process(EntryStruct struct) Process the entry (p.ex.
abstract boolean	shouldKeep() Returns whether the entry should be included in the output.
abstract boolean	shouldTransform() Whether any JarTransformers transform and relocate the struct to its "proper" location based on its package name, or just skip over it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MisplacedClassProcessor

public MisplacedClassProcessor()

Method Detail

handleMisplacedClass

public abstract void handleMisplacedClass(EntryStruct classStruct,
                                          java.lang.String className)

Handles a class that was found at a location that does not match its fully qualified classname.

Parameters:

classStruct - The jar EntryStruct for the class.

className - The actual fully-qualified classname read from the binary data.

shouldTransform

public abstract boolean shouldTransform()

Whether any JarTransformers transform and relocate the struct to its "proper" location based on its package name, or just skip over it.

Returns:

True if the struct should be transformed, false otherwise.

shouldKeep

public abstract boolean shouldKeep()

Returns whether the entry should be included in the output.

Returns:

true if it should be kept, false if it should be omitted.

process

public boolean process(EntryStruct struct)
                throws java.io.IOException

Description copied from interface: JarProcessor

Process the entry (p.ex. rename the file)

Returns true if the processor "successfully" processed the entry. In practice, "true" is used to indicate that the entry should be kept, and false is used to indicate the entry should be thrown away, and doesn't indicate anything in particular about what this JarProcessor actually did to the entry (if anything).

Specified by:

process in interface JarProcessor

Parameters:

struct - The jar entry.

Returns:

true if the process chain can continue after this process

Throws:

java.io.IOException

formatMisplacedClassMessage

protected java.lang.String formatMisplacedClassMessage(EntryStruct classStruct,
                                                       java.lang.String className)