Project

Profile

Help

Revision c7deb2a9

Added by Debbie Lockett 6 months ago

.NET code updates: tidying up documentation comments, etc. for recent development work (e.g. Bug #4839)

View differences:

src/main/csharp/api/Saxon.Api/Extensibility.cs
16 16
using JItem = net.sf.saxon.om.Item;
17 17
using JResource = net.sf.saxon.lib.Resource;
18 18
using JResourceCollection = net.sf.saxon.lib.ResourceCollection;
19
using JResourceFactory = net.sf.saxon.lib.ResourceFactory;
19 20
using JStandardCollectionFinder = net.sf.saxon.resource.StandardCollectionFinder;
20 21
using JCollectionFinder = net.sf.saxon.lib.CollectionFinder;
21 22
using System.Collections.Generic;
22
using net.sf.saxon.expr;
23
using net.sf.saxon.lib;
24 23
using net.sf.saxon.om;
25 24
using java.util;
26 25
using net.sf.saxon;
......
425 424
        /// supplied to the fn:collection or fn:uri-collection against the staticbase URI</param>
426 425
        /// <returns>a ResourceCollection object representing the resources in the collection identified
427 426
        ///  by this collection URI. Result should not be null.</returns>
428
        IResourceCollection FindCollection(DynamicContext context, String collectionURI);
427
		/**public**/ IResourceCollection FindCollection(DynamicContext context, String collectionURI);
429 428

  
430 429

  
431 430
    }
......
446 445
        /// If the collection() or uri-collection() function
447 446
        /// was called with no arguments(to get the "default collection") this
448 447
        /// will be the URI of the default collection registered with the Configuration.</returns>
449
        String CollectionURI();
448
		/**public**/ String CollectionURI();
450 449

  
451 450
        /// <summary>
452 451
        /// Get the URIs of the resources in the collection. This supports the fn:uri-collection()
......
460 459
        /// <param name="context">context the XPath evaluation context</param>
461 460
        /// <returns>an iterator over the URIs of the resources in the collection. The URIs are represented
462 461
        /// as Strings.They should preferably be absolute URIs.</returns>
463
        List<String> GetResourceURIs(DynamicContext context);
462
		/**public**/ List<String> GetResourceURIs(DynamicContext context);
464 463

  
465 464
        /// <summary>
466 465
        /// Get the resources in the collection. This supports the fn:collection() function. It is not
......
471 470
        /// <param name="context">the XPath evaluation context</param>
472 471
        /// <returns>a List over the resources in the collection. This returns objects of class
473 472
        /// <c>Riesource</c>.</returns>
474
        List<IResource> GetResources(DynamicContext context);
473
		/**public**/ List<IResource> GetResources(DynamicContext context);
475 474

  
476 475

  
477 476
    }
......
506 505
    public class JarCollection : ResourceCollection
507 506
    {
508 507

  
508
		/// <summary>
509
		/// Create a JarCollection
510
		/// </summary>
511
		/// <param name="context">The XPath dynamic context</param>
512
		/// <param name="collectionURI">the collection URI used to identify this collection 
513
		/// (typically but not necessarily the location of the JAR file)</param>
514
		/// <param name="parameters">URI query parameters appearing on the collection URI</param>
509 515
        public JarCollection(DynamicContext context, String collectionURI, URIQueryParameters parameters)
510 516
        {
511 517
            resourceCollection = new net.sf.saxon.resource.JarCollection(context.context, collectionURI, parameters.Implementation());
......
514 520

  
515 521
    }
516 522

  
523
	/// <summary>
524
	/// CatalogCollection
525
	/// </summary>
517 526
    public class CatalogCollection : ResourceCollection
518 527
    {
519 528

  
......
644 653
        /// Get a URI that identifies this resource
645 654
        /// </summary>
646 655
        /// <returns>a URI identifying the resource</returns>
647
        String GetResourceURI();
656
		/**public**/ String GetResourceURI();
648 657

  
649 658
        /// <summary>
650 659
        /// Get an XDM Item holding the contents of this resource.
......
655 664
        /// for text resources, a map or array for JSON resources, a base64Binary value
656 665
        /// for binary resource.May also return null if the resource cannot be materialized
657 666
        /// and this is not to be treated as an error.</returns>
658
        XdmItem GetXdmItem(DynamicContext context);
667
		/**public**/ XdmItem GetXdmItem(DynamicContext context);
659 668

  
660 669
        /// <summary> 
661 670
        /// Get the media type (MIME type) of the resource if known
662 671
        /// </summary>
663 672
        /// <returns>the media type if known; otherwise null</returns>
664
        String GetContentType();
673
		/**public**/ String GetContentType();
665 674
    }
666 675

  
676
	/// <summary>
677
	/// ResourceCollection
678
	/// </summary>
667 679
    public class ResourceCollection : IResourceCollection
668 680
    {
669
        protected net.sf.saxon.lib.ResourceCollection resourceCollection;
681
		protected JResourceCollection resourceCollection;
670 682

  
671 683
        internal ResourceCollection()
672 684
        {
673 685
        }
674 686

  
675 687

  
676
        internal ResourceCollection(net.sf.saxon.lib.ResourceCollection rc) {
688
		internal ResourceCollection(JResourceCollection rc) {
677 689
            resourceCollection = rc;
678 690
        }
679 691

  
......
726 738
        /// </summary>
727 739
        /// <param name="proc">the Saxon Processor</param>
728 740
        /// <returns>the resource</returns>
729
        IResource MakeResource(Processor proc);
741
		/**public**/ IResource MakeResource(Processor proc);
730 742

  
731 743
    }
732 744

  
733
    internal class ResourceFactoryWrapper : net.sf.saxon.lib.ResourceFactory
745
    internal class ResourceFactoryWrapper : JResourceFactory
734 746
    {
735 747
        private IResourceFactory resourceFactory;
736 748
        private Processor proc;
......
752 764
    {
753 765
        internal JResource resource = null;
754 766

  
755
        public Resource() { resource = null; }
767
        public Resource() 
768
		{ 
769
			resource = null; 
770
		}
756 771

  
757
        public Resource(JResource rc) {
772
        public Resource(JResource rc) 
773
		{
758 774
            resource = rc;
759 775
        }
760 776

  
......
774 790
        }
775 791
    }
776 792

  
793
	/// <summary>
794
	/// BinaryResource
795
	/// </summary>
777 796
    public class BinaryResource : Resource {
778 797

  
779 798

  
780
        public BinaryResource(String href, String contentType, byte [] content) {
799
        public BinaryResource(String href, String contentType, byte[] content) {
781 800
            resource = new net.sf.saxon.resource.BinaryResource(href, contentType, content); 
782 801
        }
783 802

  
......
785 804
    }
786 805

  
787 806

  
788
    internal class ResourceWrapper : net.sf.saxon.lib.Resource
807
    internal class ResourceWrapper : JResource
789 808
    {
790 809

  
791 810
        IResource resource;
......
810 829
    }
811 830
    
812 831

  
813
    internal class CollectionFinderWrapper : net.sf.saxon.lib.CollectionFinder
832
    internal class CollectionFinderWrapper : JCollectionFinder
814 833
    {
815 834

  
816 835
        ICollectionFinder collectionFinder;

Also available in: Unified diff