Package com.ca.apim.gateway.cagatewayexport.tasks.explode.filter.entityfilters

Class FolderFilter

java.lang.Object

com.ca.apim.gateway.cagatewayexport.tasks.explode.filter.entityfilters.FolderFilter

All Implemented Interfaces:

EntityFilter<com.ca.apim.gateway.cagatewayconfig.beans.Folder>, java.lang.Comparable<com.ca.apim.gateway.cagatewayconfig.beans.Folder>

@Singleton
public class FolderFilter
extends java.lang.Object
implements EntityFilter<com.ca.apim.gateway.cagatewayconfig.beans.Folder>

Constructor Summary

Constructors

Constructor	Description
FolderFilter()

Method Summary

Modifier and Type	Method	Description
java.util.List<com.ca.apim.gateway.cagatewayconfig.beans.Folder>	filter(java.lang.String folderPath, FilterConfiguration filterConfiguration, com.ca.apim.gateway.cagatewayconfig.beans.Bundle bundle, com.ca.apim.gateway.cagatewayconfig.beans.Bundle filteredBundle)	Filters entities in the bundle and returns the list of filtered entities.
@NotNull java.util.Collection<java.lang.Class<? extends EntityFilter>>	getDependencyEntityFilters()
static java.util.List<com.ca.apim.gateway.cagatewayconfig.beans.Folder>	parentFolders(java.lang.String folderPath, com.ca.apim.gateway.cagatewayconfig.beans.Bundle bundle)	Returns a list of parent folders from the given bundle for the folder with the given path

Methods inherited from interface com.ca.apim.gateway.cagatewayexport.tasks.explode.filter.EntityFilter

compareTo, getEntityFilterFromClass, getFilterableEntityName, isDependency

Methods inherited from class java.lang.Object

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

Constructor Detail

FolderFilter

public FolderFilter()

Method Detail

getDependencyEntityFilters

@NotNull
public @NotNull java.util.Collection<java.lang.Class<? extends EntityFilter>> getDependencyEntityFilters()

Specified by:

getDependencyEntityFilters in interface EntityFilter<com.ca.apim.gateway.cagatewayconfig.beans.Folder>

Returns:

the position of the entity filter, has to be non null and not conflicting

filter

public java.util.List<com.ca.apim.gateway.cagatewayconfig.beans.Folder> filter(java.lang.String folderPath,
                                                                               FilterConfiguration filterConfiguration,
                                                                               com.ca.apim.gateway.cagatewayconfig.beans.Bundle bundle,
                                                                               com.ca.apim.gateway.cagatewayconfig.beans.Bundle filteredBundle)

Description copied from interface: EntityFilter

Filters entities in the bundle and returns the list of filtered entities. Filtered entities are entities that are meant to be kept.

Specified by:

filter in interface EntityFilter<com.ca.apim.gateway.cagatewayconfig.beans.Folder>

Parameters:

folderPath - The folder path that will be filtered

filterConfiguration - This is the filter configuration.

bundle - The bundle to filter entities from

filteredBundle - The filtered bundle containing already filtered entities.

Returns:

The list of entities filtered from the bundle

parentFolders

public static java.util.List<com.ca.apim.gateway.cagatewayconfig.beans.Folder> parentFolders(java.lang.String folderPath,
                                                                                             com.ca.apim.gateway.cagatewayconfig.beans.Bundle bundle)

Returns a list of parent folders from the given bundle for the folder with the given path

Parameters:

folderPath - The folder path to get parent folders for

bundle - The bundle to find the parent folders in

Returns:

The list of parent folders for the given folder path