pathfixer

Documentation

Index

• type Location
  • func NewLocation(location string) *Location
  • func NewLocationUsingOptions(location string, options PathOptions) *Location
  • func (it *Location) ClonePath() *Location
  • func (it *Location) CompiledPath() string
  • func (it *Location) HasPath() bool
  • func (it *Location) IsEmptyPath() bool
  • func (it *Location) IsPathExist() bool
• type PathOptions
  • func (it *PathOptions) ClonePathOptions() *PathOptions
  • func (it *PathOptions) GetFixedPath(location string) string
  • func (it *PathOptions) GetFixedPathJoined(location1, location2 string) string
  • func (it *PathOptions) GetFixedPathJoinedMany(locations ...string) string

Types

type Location

type Location struct {
	PathOptions
	Path string `json:"Location,omitempty"` // empty path will be ignored from applying.
	// contains filtered or unexported fields
}

func NewLocation

func NewLocation(location string) *Location

func NewLocationUsingOptions

func NewLocationUsingOptions(
	location string,
	options PathOptions,
) *Location

func (*Location) ClonePath

func (it *Location) ClonePath() *Location

func (*Location) CompiledPath

func (it *Location) CompiledPath() string

func (*Location) HasPath

func (it *Location) HasPath() bool

func (*Location) IsEmptyPath

func (it *Location) IsEmptyPath() bool

func (*Location) IsPathExist

func (it *Location) IsPathExist() bool

IsPathExist returns true if exist on the file system

type PathOptions

type PathOptions struct {
	IsContinueOnError bool `json:"IsContinueOnError,omitempty"`
	IsNormalize       bool `json:"IsNormalize,omitempty"`
	IsExpandEnvVar    bool `json:"IsExpandEnvVariable,omitempty"` // can expand environment variables with %{Name} $Name %{Java_home} ${Java_HOME}
	IsRecursive       bool `json:"IsRecursive,omitempty"`
	IsSkipOnInvalid   bool `json:"IsSkipOnInvalid,omitempty"`
	IsSkipOnExist     bool `json:"IsSkipOnExist,omitempty"`
	IsSkipOnEmpty     bool `json:"IsSkipOnEmpty,omitempty"`
	IsRelative        bool `json:"IsRelative,omitempty"`
}

func (*PathOptions) ClonePathOptions

func (it *PathOptions) ClonePathOptions() *PathOptions

func (*PathOptions) GetFixedPath

func (it *PathOptions) GetFixedPath(location string) string

func (*PathOptions) GetFixedPathJoined

func (it *PathOptions) GetFixedPathJoined(location1, location2 string) string

func (*PathOptions) GetFixedPathJoinedMany

func (it *PathOptions) GetFixedPathJoinedMany(
	locations ...string,
) string