org.clafer.scope

Class ScopeBuilder

java.lang.Object

org.clafer.scope.ScopeBuilder

All Implemented Interfaces:

Scopable

public class ScopeBuilder
extends Object
implements Scopable

Builder pattern for scopes. Use Scope.builder(), Scope.setScope(org.clafer.ast.AstClafer, int), Scope.defaultScope(int), Scope.intLow, or Scope.intHigh to construct the builder. The default scope and lowest and highest integers will be given a default if not set explicitly.

Author:

jimmy

See Also:

Scope

Method Summary

Methods

Modifier and Type	Method and Description
ScopeBuilder	adjustDefaultScope(int adjust) Adjust the scope of unspecified Clafers.
ScopeBuilder	adjustIntHigh(int adjust) Adjust the highest integer used for solving.
ScopeBuilder	adjustIntLow(int adjust) Adjust the lowest integer used for solving.
ScopeBuilder	adjustScope(AstClafer clafer, int adjust) Adjust the scope of the Clafer.
ScopeBuilder	defaultScope(int defaultScope) Set the scope for unspecified Clafers.
ScopeBuilder	intHigh(int intHigh) Set the highest (inclusive) integer used for solving.
ScopeBuilder	intLow(int intLow) Set the lowest (inclusive) integer used for solving.
ScopeBuilder	setScope(AstClafer clafer, int scope) Set the scope of the Clafer.
Scope	toScope() Finalizes all the decisions made in the builder.

Methods inherited from class java.lang.Object

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

Method Detail

setScope

public ScopeBuilder setScope(AstClafer clafer,
                    int scope)

Set the scope of the Clafer. If the scope is already set for the Clafer, then the new scope overrides the previous one.

Parameters:

clafer - the Clafer

scope - the scope of the clafer

Returns:

this builder

adjustScope

public ScopeBuilder adjustScope(AstClafer clafer,
                       int adjust)

Adjust the scope of the Clafer. If the Clafer already has a scope then newScope = oldScope + adjust. Otherwise newScope = defaultScope + adjust.

Parameters:

clafer - the Clafer

adjust - increment the scope by this amount

Returns:

this builder

defaultScope

public ScopeBuilder defaultScope(int defaultScope)

Set the scope for unspecified Clafers. If the default scope is already set, then the new default scope overrides the previous one.

Parameters:

defaultScope - the default scope

Returns:

this builder

adjustDefaultScope

public ScopeBuilder adjustDefaultScope(int adjust)

Adjust the scope of unspecified Clafers.

Parameters:

adjust - increment the default scope by this amount

Returns:

this builder

intLow

public ScopeBuilder intLow(int intLow)

Set the lowest (inclusive) integer used for solving. If the lowest integer is already set, then the new lowest integer overrides the previous one.

Parameters:

intLow - the lowest integer

Returns:

this builder

adjustIntLow

public ScopeBuilder adjustIntLow(int adjust)

Adjust the lowest integer used for solving.

Parameters:

adjust - increment the lowest integer by this amount

Returns:

this builder

intHigh

public ScopeBuilder intHigh(int intHigh)

Set the highest (inclusive) integer used for solving. If the highest integer is already set, then the new highest integer overrides the previous one.

Parameters:

intHigh - the highest integer

Returns:

this builder

adjustIntHigh

public ScopeBuilder adjustIntHigh(int adjust)

Adjust the highest integer used for solving.

Parameters:

adjust - increment the highest integer by this amount

Returns:

this builder

toScope

public Scope toScope()

Finalizes all the decisions made in the builder. Further changes to this builder is permitted for building more scopes, but the returned scope will not be affected.

Specified by:

toScope in interface Scopable

Returns:

the built scope