org.craftercms.core.xml.mergers.impl.strategies

Class SingleFileMergeStrategy

java.lang.Object

org.craftercms.core.xml.mergers.impl.strategies.SingleFileMergeStrategy

All Implemented Interfaces:

DescriptorMergeStrategy

public class SingleFileMergeStrategy
extends Object
implements DescriptorMergeStrategy

DescriptorMergeStrategy that returns the same specified descriptor URL. This means there's no need for merging.

Author:

Sumer Jabri, Alfonso Vásquez

Constructor Summary

Constructors

Constructor and Description
SingleFileMergeStrategy()

Method Summary

Modifier and Type	Method and Description
List<MergeableDescriptor>	getDescriptors(Context context, CachingOptions cachingOptions, String mainDescriptorUrl, org.dom4j.Document mainDescriptorDom) Returns the list of descriptors in the order they should be merged, given the URI of the primary descriptor.
List<MergeableDescriptor>	getDescriptors(Context context, CachingOptions cachingOptions, String mainDescriptorUrl, org.dom4j.Document mainDescriptorDom, boolean mainDescriptorOptional) Returns the list of descriptors in the order they should be merged, given the URI of the primary descriptor.

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleFileMergeStrategy

public SingleFileMergeStrategy()

Method Detail

getDescriptors

public List<MergeableDescriptor> getDescriptors(Context context,
                                                CachingOptions cachingOptions,
                                                String mainDescriptorUrl,
                                                org.dom4j.Document mainDescriptorDom)
                                         throws XmlMergeException

Description copied from interface: DescriptorMergeStrategy

Returns the list of descriptors in the order they should be merged, given the URI of the primary descriptor.

Specified by:

getDescriptors in interface DescriptorMergeStrategy

Parameters:

context - the current context

cachingOptions - caching options in case you need access to items

mainDescriptorUrl - the URL of the main descriptor

mainDescriptorDom - the DOM of the main descriptor

Returns:

a list of MergeableDescriptors representing the descriptors to merge

Throws:

XmlMergeException

getDescriptors

public List<MergeableDescriptor> getDescriptors(Context context,
                                                CachingOptions cachingOptions,
                                                String mainDescriptorUrl,
                                                org.dom4j.Document mainDescriptorDom,
                                                boolean mainDescriptorOptional)
                                         throws XmlMergeException

Description copied from interface: DescriptorMergeStrategy

Returns the list of descriptors in the order they should be merged, given the URI of the primary descriptor.

Specified by:

getDescriptors in interface DescriptorMergeStrategy

Parameters:

context - the current context

cachingOptions - caching options in case you need access to items

mainDescriptorUrl - the URL of the primary descriptor

mainDescriptorDom - the DOM of the main descriptor

mainDescriptorOptional - if the primary descriptor should be marked as optional

Returns:

a list of MergeableDescriptors representing the descriptors to merge

Throws:

XmlMergeException