commandbox.system.endpoints

Class Folder

lucee.Component
    extended by commandbox.system.endpoints.Folder
All Implemented Interfaces:
IEndpoint

Copyright Since 2014 CommandBox by Ortus Solutions, Corp www.coldbox.org | www.ortussolutions.com I am the folder endpoint. I get packages from a local folder.

Class Attributes:
  • singleton
    •  
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
  • author : Brad Wood, Luis Majano, Denny Valliant
    •  
    Property Summary
    type property default serializable required
    string namePrefixes


    • access = public
    • returntype = any
    		 true false
    any packageService


    • access = public
    • returntype = any
    • inject = packageService
    		 true false
    any semanticVersion


    • access = public
    • returntype = any
    • inject = provider:semanticVersion@semver
    		 true false
    Constructor Summary
    init()
    Method Summary
    any getDefaultName(string package)
         Determines the name of a package based on its ID if there is no box.
    string getNamePrefixes()
    string getPackageService()
    string getSemanticVersion()
    any getUpdate(string package, string version, [boolean verbose='false'])
    string resolvePackage(string package, [boolean verbose='false'])
    any setNamePrefixes(string namePrefixes)
    any setPackageService(any packageService)
    any setSemanticVersion(any semanticVersion)
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init()

    Property Detail

    namePrefixes

    property string namePrefixes

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    packageService

    property any packageService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - packageService
    serializable - true

    semanticVersion

    property any semanticVersion

    Attributes:
    access - public
    required - false
    returntype - any
    inject - provider:semanticVersion@semver
    serializable - true
    Method Detail

    getDefaultName

    public any getDefaultName(string package)

    Determines the name of a package based on its ID if there is no box.json

    Specified by:
    getDefaultName in interface IEndpoint
    Parameters:
    package

    getNamePrefixes

    public string getNamePrefixes()

    getPackageService

    public string getPackageService()

    getSemanticVersion

    public string getSemanticVersion()

    getUpdate

    public any getUpdate(string package, string version, [boolean verbose='false'])

    Specified by:
    getUpdate in interface IEndpoint
    Parameters:
    package
    version
    verbose

    resolvePackage

    public string resolvePackage(string package, [boolean verbose='false'])

    Specified by:
    resolvePackage in interface IEndpoint
    Parameters:
    package
    verbose

    setNamePrefixes

    public any setNamePrefixes(string namePrefixes)

    Parameters:
    namePrefixes

    setPackageService

    public any setPackageService(any packageService)

    Parameters:
    packageService

    setSemanticVersion

    public any setSemanticVersion(any semanticVersion)

    Parameters:
    semanticVersion