org.zanata.client.commands.pull

Class AbstractPullStrategy

java.lang.Object

org.zanata.client.commands.pull.AbstractPullStrategy

All Implemented Interfaces:

PullStrategy

Direct Known Subclasses:

AbstractGettextPullStrategy, PropertiesStrategy, XliffStrategy, XmlStrategy

public abstract class AbstractPullStrategy
extends Object
implements PullStrategy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPullStrategy(PullOptions opts)

Method Summary

Modifier and Type	Method and Description
PullOptions	getOpts()
File	getTransFileToWrite(String docName, LocaleMapping localeMapping) Provides the file reference that will be used to write a Translation file for a given Resource.
boolean	isTransOnly() Indicates if this strategy must work without access to source files.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.zanata.client.commands.pull.PullStrategy

getExtensions, needsDocToWriteTrans, writeSrcFile, writeTransFile

Constructor Detail

AbstractPullStrategy

protected AbstractPullStrategy(PullOptions opts)

Method Detail

getOpts

public PullOptions getOpts()

isTransOnly

public boolean isTransOnly()

Description copied from interface: PullStrategy

Indicates if this strategy must work without access to source files. No attempt should be made to read, write or push source documents for a trans-only strategy.

Specified by:

isTransOnly in interface PullStrategy

Returns:

true if this strategy only allows interactions with translation files.

getTransFileToWrite

public File getTransFileToWrite(String docName,
                                LocaleMapping localeMapping)

Description copied from interface: PullStrategy

Provides the file reference that will be used to write a Translation file for a given Resource. Ideally, this method should be used by concrete implementations of the strategy to write the file.

Specified by:

getTransFileToWrite in interface PullStrategy

Parameters:

docName - may be null if needsDocToWriteTrans() returns false

localeMapping - Locale mapping to use.

Returns:

A File reference (might not exist physically) to which a Translation Resource will be written.